Gets the list of services supported, based on request can optionally include the service details for each service.
When the app's settings are changed, a setting change event will be delivered in following formats. The AppSettingChanged event is generated only in JSON schema format.
tns1:OpenApp/WiseAI/AppSettingChanged
<?xml version="1.0" encoding="UTF-8"?>
<AppSettingChanged wstop:topic="true" xmlns:tt="http://www.onvif.org/ver10/schema">
<tt:MessageDescription IsProperty="true">
<tt:Source>
<tt:SimpleItemDescription Name="VideoSourceToken" Type="tt:ReferenceToken"/>
</tt:Source>
<tt:Data>
<tt:SimpleItemDescription Name="Path" Type="xsd:string"/>
</tt:Data>
</tt:MessageDescription>
</AppSettingChanged>
{
"EventName": "OpenSDK.WiseAI.AppSettingChanged",
"Time": "2021-10-27T07:36:14.509+00:00",
"Source": {
"Channel": 0,
"AppName": "WiseAI",
"AppEvent": "AppSettingChanged",
"AppID": "WiseAI",
"Type": "Event",
"RuleIndex": 1,
"VideoSourceToken": "VideoSourceToken-0"
},
"Data": {
"Path": "/configuration/objectdetection"
}
}
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
| includeDetails | boolean Optional capability include service details, if set to true response will also have service details. |
{- "appName": "string",
- "modelName": "string",
- "appVersion": "string",
- "cgiVersion": "string",
- "manufacturer": "string",
- "language": "English",
- "maxChannels": 0,
- "serviceCapabilities": [
- {
- "channel": 0,
- "supportedServices": [
- "string"
], - "serviceDetails": [
- {
- "name": "string",
- "id": "string",
- "baseUrl": "string",
- "urls": [
- {
- "path": "string",
- "methods": [
- "get"
]
}
]
}
]
}
]
}Get service level capability for each channel, client can decide which api is supported and for which channel
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "capabilities": [
- {
- "channel": 0,
- "aiSettings": true,
- "crowdcounting": true,
- "dataserver": false,
- "facemaskdetection": true,
- "frameMetaType": "Detailed",
- "heatmap": true,
- "shoppingcartheatmap": true,
- "vehicleheatmap": true,
- "forkliftheatmap": true,
- "imagetransfer": true,
- "imagetransferTypes": [
- "Object"
], - "ivaarea": true,
- "linecrossing": true,
- "maxResolution": {
- "height": 1080,
- "width": 1920
}, - "objectcounting": true,
- "objectcountingTypes": [
- "Person",
- "Vehicle"
], - "objectdetection": true,
- "queuemanagement": true,
- "vehiclequeuemanagement": true,
- "shoppingcartqueuemanagement": true,
- "forkliftqueuemanagement": true,
- "rotation": false,
- "slipAndFallDetection": true,
- "socialdistancing": true,
- "stoppedvehicledetection": false,
- "trafficjamdetection": false,
- "vehiclespeeddetection": false,
- "forkliftspeeddetection": true,
- "blockedexitdetection": true,
- "wisedetector": true,
- "wisedetectorMaxModels": 2,
- "motiondetectionarea": true,
- "soundclassification": true,
- "dynamicprivacymask": true,
- "license": true,
- "applicationLicense": false,
- "addOnLicense": true,
- "sightmind": true,
- "pedestriandetection": true,
- "wrongwaydetection": true,
- "multilanevehicledetection": true,
- "commercialVehicleDetection": true,
- "flexai": true,
- "flexaiMaxModels": 2
}
]
}Gets the service capability, client can decide which api is supported and for which channel
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "systemlog": true,
- "systemlogTypes": [
- "string"
], - "utcTimeSearch": true,
- "localTimeSearch": true,
- "capabilities": [
- {
- "channel": 0,
- "eventlog": true,
- "eventlogTypes": [
- "string"
], - "objectcounting": {
- "genderAgeInfo": true
}
}
]
}Get AI configurations, a device that indicates capability of aisettings in getcapability command shall support this command. This API can selects channels to enable AI features, and if you turn off a channel, all AI features on that channel will be automatically disabled. Conversely, if a particular AI channel is turned off, it will automatically be turned on when you turn on one of that channel's AI events. If an event setting cannot be turned on due to limitations, it responds with an error code 617 Configuration Limited.
{- "aiSettings": [
- {
- "channel": 0,
- "enable": true
}
]
}Update AI settings, a device that indicates capability of aisettings in getcapability command shall support this command.
Array of objects (AISettingsElement) | |||||
Array
| |||||
{- "aiSettings": [
- {
- "channel": 0,
- "enable": true
}
]
}{- "response": "Success"
}Get AI settings options, a device that indicates capability of aisettings in getcapability command shall support this command.
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "maxAvailableChannels": 0,
- "isReadonly": true,
- "aiSettingsOptions": [
- {
- "channel": 0,
- "aiSupport": true
}
]
}Get the object detection event configurations, a device that indicates capability of objectdetection in getcapability command shall support this command. When this objectdetection feature is enabled event will be delivered in following formats.
tns1:OpenApp/WiseAI/ObjectDetection
<?xml version="1.0" encoding="UTF-8"?>
<ObjectDetection wstop:topic="true" xmlns:tt="http://www.onvif.org/ver10/schema">
<tt:MessageDescription IsProperty="true">
<tt:Source>
<tt:SimpleItemDescription Name="VideoSourceToken" Type="tt:ReferenceToken"/>
<tt:SimpleItemDescription Name="RuleName" Type="xsd:string"/>
</tt:Source>
<tt:Data>
<tt:SimpleItemDescription Name="ClassTypes" Type="tt:StringList"/>
<tt:SimpleItemDescription Name="State" Type="xsd:boolean"/>
</tt:Data>
</tt:MessageDescription>
</ObjectDetection>
Channel.0.OpenSDK.WiseAI.ObjectDetection=True
Channel.0.OpenSDK.WiseAI.ObjectDetection.1=True
Channel.0.OpenSDK.WiseAI.ObjectDetection=True
Channel.0.OpenSDK.WiseAI.ObjectDetection.1.VideoSourceToken=Token1
Channel.0.OpenSDK.WiseAI.ObjectDetection.1.RuleName=RuleName1
Channel.0.OpenSDK.WiseAI.ObjectDetection.1.ClassType=Person Vehicle
Channel.0.OpenSDK.WiseAI.ObjectDetection.1.State=True
{
"EventName": "OpenSDK.WiseAI.ObjectDetection",
"Time": "2021-10-27T07:36:14.509+00:00",
"Source": {
"Channel": 0,
"AppName": "WiseAI",
"AppEvent": "ObjectDetection",
"AppID": "WiseAI",
"Type": "Event",
"RuleIndex": 1,
"VideoSourceToken": "VideoSourceToken-0",
"RuleName": "Rule1",
},
"Data": {
"ClassTypes": "Person Vehicle",
"State": true
}
}
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "objectDetection": [
- {
- "channel": 0,
- "enable": true,
- "duration": 0,
- "objectTypes": [
- "string"
]
}
]
}object detecion setting, a device that indicates capability of objectdetection in getcapability command shall support this command.
| channel required | integer <int32> |
| enable | boolean |
| duration | integer <int32> Minimum duration for which object is detected before raising event. Valid range is provided in options. |
| objectTypes | Array of strings List of objectTypes to be detected, supported list is provided in options. Eg, Face, Vehicle, Person etc., |
{- "channel": 0,
- "enable": true,
- "duration": 0,
- "objectTypes": [
- "string"
]
}{- "response": "Success"
}Get the object detection event configurations options, a device that indicates capability of objectdetection in getcapability command shall support this command.
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "objectDetectionOptions": [
- {
- "channel": 0,
- "duration": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "objectTypes": [
- "string"
]
}
]
}To get the list of object types for which imagetransfer is supported. Only for provided object type, meta image sending would be supported, a device that indicates capability of imagetransfer in getcapability command shall support this command.
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "imageTransfer": [
- {
- "channel": 0,
- "enable": true,
- "objectTypes": [
- "string"
], - "imageQuality": 1,
- "base64ObjectImage": true
}
]
}To set the list of object types for which imagetransfer is required. Only for provided object type, image sending would be supported. A device that indicates capability of imagetransfer in getcapability command shall support this command.
| channel required | integer <int32> |
| enable | boolean |
| objectTypes | Array of strings List of objectTypes to be detected, supported list is provided in options. Eg, Face, Vehicle, Person etc., |
| imageQuality | integer <int32> [ 1 .. 100 ] Parameter to control the quality of image, 100 refers to highest quality image. |
| base64ObjectImage | boolean Whether to include base64 image in metadata |
{- "channel": 0,
- "enable": true,
- "objectTypes": [
- "string"
], - "imageQuality": 1,
- "base64ObjectImage": true
}{- "response": "Success"
}To provide the supported object types for which image transfer is possible. ObjectTypes signalled here can be used in imagetransfer api, a device that indicates capability of imagetransfer in getcapability command shall support this command.
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "imageTransferOptions": [
- {
- "channel": 0,
- "objectTypes": [
- "string"
]
}
]
}To get list of object types that provide meta transfer. Only for provided object type, frame metadata with detail attribute would be sended, Indicates that the device will support this command if the getcapability command specifies that the Metadata is "Detailed".
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "metaTransfer": [
- {
- "channel": 0,
- "enable": true,
- "objectTypes": [
- "string"
]
}
]
}To set the list of object types for which detail metatransfer is required. Only for provided object type, frame metadata with detail attribute would be sended, Indicates that the device will support this command if the getcapability command specifies that the Metadata is "Detailed".
| channel required | integer <int32> |
| enable | boolean |
| objectTypes | Array of strings List of objectTypes to be sended detail metadata attributes, supported list is provided in options. Eg, Face, Vehicle, Person etc., |
{- "channel": 0,
- "enable": true,
- "objectTypes": [
- "string"
]
}{- "response": "Success"
}To provide the supported attribute types for which meta attribute transfer is possible. ObjectTypes signalled here can be used in metatransfer api. Indicates that the device will support this command if the getcapability command specifies that the Metadata is "Detailed".
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "metaTransferOptions": [
- {
- "channel": 0,
- "objectTypes": [
- "string"
]
}
]
}Get the area based analytics configurations. Area based analytics configurations, a device that indicates capability of ivaarea in getcapability command shall support this command. When this ivaarea feature is enabled event will be delivered following below schema format.
tns1:OpenApp/WiseAI/IvaArea
<?xml version="1.0" encoding="UTF-8"?>
<IvaArea wstop:topic="true">
<tt:MessageDescription>
<tt:Source>
<tt:SimpleItemDescription Name="VideoSourceToken" Type="tt:ReferenceToken"/>
<tt:SimpleItemDescription Name="RuleName" Type="xsd:string"/>
</tt:Source>
<tt:Data>
<tt:SimpleItemDescription Name="State" Type="xsd:boolean"/>
<tt:SimpleItemDescription Name="ObjectId" Type="tt:StringList"/>
<tt:SimpleItemDescription Name="Action" Type="tt:StringList"/>
</tt:Data>
</tt:MessageDescription>
</IvaArea>
Channel.0.OpenSDK.WiseAI.IvaArea=True
Channel.0.OpenSDK.WiseAI.IvaArea.1=True
Channel.0.OpenSDK.WiseAI.IvaArea=True
Channel.0.OpenSDK.WiseAI.IvaArea.1.VideoSourceToken=VideoSourceToken-0
Channel.0.OpenSDK.WiseAI.IvaArea.1.RuleName=Rule1
Channel.0.OpenSDK.WiseAI.IvaArea.1.State=True
Channel.0.OpenSDK.WiseAI.IvaArea.1.ObjectId=1
Channel.0.OpenSDK.WiseAI.IvaArea.1.Action=Intrusion
Channel.0.OpenSDK.WiseAI.IvaArea.2.VideoSourceToken=VideoSourceToken-0
Channel.0.OpenSDK.WiseAI.IvaArea.2.RuleName=Rule2
Channel.0.OpenSDK.WiseAI.IvaArea.2.State=True
Channel.0.OpenSDK.WiseAI.IvaArea.2.ObjectId=2
Channel.0.OpenSDK.WiseAI.IvaArea.2.Action=Enter
{
"EventName": "OpenSDK.WiseAI.IvaArea",
"Time": "2021-10-27T07:36:14.509+00:00",
"Source": {
"Channel": 0,
"AppName": "WiseAI",
"AppID": "WiseAI",
"AppEvent": "IvaArea",
"Type": "Event",
"RuleIndex": 1,
"VideoSourceToken": "VideoSourceToken-0",
"RuleName": "Rule1",
},
"Data": {
"State": true,
"ObjectId": "1",
"Action": "Enter"
}
}
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "ivaArea": [
- {
- "channel": 0,
- "enable": true,
- "definedArea": [
- {
- "index": 1,
- "name": "string",
- "areaCoordinates": [
- {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}
], - "detectionModes": [
- "string"
], - "appearanceDuration": 0,
- "intrusionDuration": 0,
- "loiteringDuration": 0,
- "objectTypeFilter": [
- "string"
]
}
]
}
]
}Update or enable area based analytics configuration. Area based analytics configurations, a device that indicates capability of ivaarea in getcapability command shall support this command.
| channel required | integer <int32> | ||||||||||||||||||||||
| enable | boolean | ||||||||||||||||||||||
Array of objects (IvaAreaElement) | |||||||||||||||||||||||
Array
| |||||||||||||||||||||||
{- "channel": 0,
- "enable": true,
- "definedArea": [
- {
- "index": 1,
- "name": "string",
- "areaCoordinates": [
- {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}
], - "detectionModes": [
- "string"
], - "appearanceDuration": 0,
- "intrusionDuration": 0,
- "loiteringDuration": 0,
- "objectTypeFilter": [
- "string"
]
}
]
}{- "response": "Success"
}Provide allowed values of each parameters in area based analytics configuration. Ranges of parameters in area based analytcis configuration, a device that indicates capability of ivaarea in getcapability command shall support this command.
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "ivaAreaOptions": [
- {
- "channel": 0,
- "definedAreaOptions": {
- "detectionModes": [
- "string"
], - "index": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "areaCoordinates": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "appearanceDuration": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "intrusionDuration": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "loiteringDuration": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "objectTypeFilter": [
- "string"
]
}
}
]
}Delete the area for the requested index.
| channel required | integer <int32> Required channel parameter, operation is applicable only for the specified channel. |
| index required | Array of integers <int32> non-empty [ items <int32 > >= 1 ] Examples:
Required parameter, used to set a specific index. |
{- "response": "Success"
}Get the line based analytics configurations. Line based analytics configurations, a device that indicates capability of linecrossing in getcapability command shall support this command. When linecrossing feature is enabled event will be delivered following below schema format.
tns1:OpenApp/WiseAI/LineCrossing
<?xml version="1.0" encoding="UTF-8"?>
<LineCrossing wstop:topic="true">
<tt:MessageDescription>
<tt:Source>
<tt:SimpleItemDescription Name="VideoSourceToken" Type="tt:ReferenceToken"/>
<tt:SimpleItemDescription Name="RuleName" Type="xsd:string"/>
</tt:Source>
<tt:Data>
<tt:SimpleItemDescription Name="State" Type="xsd:boolean"/>
<tt:SimpleItemDescription Name="ObjectId" Type="tt:StringList"/>
<tt:SimpleItemDescription Name="Action" Type="tt:StringList"/>
</tt:Data>
</tt:MessageDescription>
</LineCrossing>
Channel.0.OpenSDK.WiseAI.LineCrossing=True
Channel.0.OpenSDK.WiseAI.LineCrossing.1=True
Channel.0.OpenSDK.WiseAI.LineCrossing=True
Channel.0.OpenSDK.WiseAI.LineCrossing.1.VideoSourceToken=VideoSourceToken-0
Channel.0.OpenSDK.WiseAI.LineCrossing.1.RuleName=RuleName1
Channel.0.OpenSDK.WiseAI.LineCrossing.1.State=1
Channel.0.OpenSDK.WiseAI.LineCrossing.1.ObjectId=1
Channel.0.OpenSDK.WiseAI.LineCrossing.1.Action=Left
{
"EventName": "OpenSDK.WiseAI.LineCrossing",
"Time": "2021-10-27T07:36:14.509+00:00",
"Source": {
"Channel": 0,
"AppName": "WiseAI",
"AppID": "WiseAI",
"AppEvent": "LineCrossing",
"Type": "Event",
"RuleIndex": 1,
"VideoSourceToken": "VideoSourceToken-0",
"RuleName": "RuleName1",
},
"Data": {
"State": true,
"ObjectId": "1"
}
}
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "lineCrossing": [
- {
- "channel": 0,
- "enable": true,
- "line": [
- {
- "index": 1,
- "name": "string",
- "lineCoordinates": [
- {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}
], - "mode": "Off",
- "objectTypeFilter": [
- "string"
]
}
]
}
]
}Update or enable line based analytics configuration. Line based analytics configurations, a device that indicates capability of linecrossing in getcapability command shall support this command.
| channel required | integer <int32> | ||||||||||||||||
| enable | boolean | ||||||||||||||||
Array of objects (LineCrossingElement) | |||||||||||||||||
Array
| |||||||||||||||||
{- "channel": 0,
- "enable": true,
- "line": [
- {
- "index": 1,
- "name": "string",
- "lineCoordinates": [
- {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}
], - "mode": "Off",
- "objectTypeFilter": [
- "string"
]
}
]
}{- "response": "Success"
}Provide allowed values of each parameters in line based analytics configuration. Ranges of parameters in line based analytcis configuration, a device that indicates capability of linecrossing in getcapability command shall support this command.
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "lineCrossingOptions": [
- {
- "channel": 0,
- "lineOptions": {
- "index": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "lineCoordinates": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "mode": [
- "string"
], - "objectTypeFilter": [
- "string"
]
}
}
]
}Delete the lines based on requested index.
| channel required | integer <int32> Required channel parameter, operation is applicable only for the specified channel. |
| index required | Array of integers <int32> non-empty [ items <int32 > >= 1 ] Examples:
Required parameter, used to set a specific index. |
{- "response": "Success"
}Common exclude region settings for all analytics detections
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "excludeAreaConfiguration": [
- {
- "channel": 0,
- "enableObjectMeta": true,
- "excludeAreas": [
- {
- "index": 1,
- "name": "string",
- "areaCoordinates": [
- {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}
]
}
]
}
]
}Update the common exclude region settings
| channel required | integer <int32> | ||||||||||||
| enableObjectMeta | boolean When enabled object metadata would be generated for exclude regions. | ||||||||||||
Array of objects (ExcludeAreaElement) | |||||||||||||
Array
| |||||||||||||
{- "channel": 0,
- "enableObjectMeta": true,
- "excludeAreas": [
- {
- "index": 1,
- "name": "string",
- "areaCoordinates": [
- {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}
]
}
]
}{- "response": "Success"
}Provide allowed values of each parameters in analyticexcludesettings configuration. Ranges of parameters and max supported regions are provided here
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "excludeAreaConfigurationOptions": [
- {
- "channel": 0,
- "excludeAreaOptions": {
- "index": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "areaCoordinates": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}
}
}
]
}Delete the excludearea based on requested index.
| channel required | integer <int32> Required channel parameter, operation is applicable only for the specified channel. |
| index required | Array of integers <int32> non-empty [ items <int32 > >= 1 ] Examples:
Required parameter, used to set a specific index. |
{- "response": "Success"
}gets the face mask detection settings that is configured. Can check if this feature is supported from the configuration/capability response.
tns1:OpenApp/WiseAI/MaskDetection
<?xml version="1.0" encoding="UTF-8"?>
<MaskDetection wstop:topic="true">
<tt:MessageDescription>
<tt:Source>
<tt:SimpleItemDescription Name="VideoSourceToken" Type="tt:ReferenceToken"/>
<tt:SimpleItemDescription Name="RuleName" Type="xsd:string"/>
</tt:Source>
<tt:Data>
<tt:SimpleItemDescription Name="State" Type="xsd:boolean"/>
<tt:SimpleItemDescription Name="ObjectId" Type="xsd:integer"/>
</tt:Data>
</tt:MessageDescription>
</MaskDetection>
Channel.0.OpenSDK.WiseAI.MaskDetection=True
Channel.0.OpenSDK.WiseAI.MaskDetection.1=True
Channel.0.OpenSDK.WiseAI.MaskDetection=True
Channel.0.OpenSDK.WiseAI.MaskDetection.1.VideoSourceToken=VideoSourceToken-0
Channel.0.OpenSDK.WiseAI.MaskDetection.1.RuleName=RuleName1
Channel.0.OpenSDK.WiseAI.MaskDetection.1.State=True
Channel.0.OpenSDK.WiseAI.MaskDetection.1.ObjectId=1
{
"EventName": "OpenSDK.WiseAI.MaskDetection",
"Time": "2022-03-15T02:58:52.820+00:00",
"Source": {
"Channel": 0,
"AppName": "WiseAI",
"AppID": "WiseAI",
"AppEvent": "MaskDetection",
"Type": "Event",
"RuleIndex": 1,
"VideoSourceToken": "VideoSourceToken-0",
"RuleName": "rulename"
},
"Data": {
"State": true
"ObjectId": 1
}
}
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "faceMaskDetection": [
- {
- "channel": 0,
- "enable": true,
- "detectionMode": "Mask",
- "duration": 0
}
]
}Configures the face mask detection settings, for supported values and ranges refer to facemaskdeteciton/options response.
| channel | integer <int32> |
| enable | boolean |
| detectionMode | string Enum: "Mask" "NoMask" |
| duration | integer <int32> |
{- "channel": 0,
- "enable": true,
- "detectionMode": "Mask",
- "duration": 0
}{- "response": "Success"
}Supported values and ranges reguired for configuring face mask detection is provided in response.
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "faceMaskDetectionOptions": [
- {
- "channel": 0,
- "detectionMode": [
- "string"
], - "duration": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}
}
]
}Area and rule based stopped-vehicle detection configurations, a device that indicates capability of stoppedvehicledetection in getcapability command shall support this command. When StoppedVehicleDetection is enabled, event is delivered in below formats,
tns1:OpenApp/WiseAI/StoppedVehicleDetection
<?xml version="1.0" encoding="UTF-8"?>
<StoppedVehicleDetection wstop:topic="true">
<tt:MessageDescription>
<tt:Source>
<tt:SimpleItemDescription Name="VideoSourceToken" Type="tt:ReferenceToken"/>
<tt:SimpleItemDescription Name="RuleName" Type="xsd:string"/>
</tt:Source>
<tt:Data>
<tt:SimpleItemDescription Name="State" Type="xsd:boolean"/>
<tt:SimpleItemDescription Name="VehicleTypes" Type="tt:StringList"/>
<tt:SimpleItemDescription Name="ObjectIDs" Type="tt:StringList"/>
</tt:Data>
</tt:MessageDescription>
</StoppedVehicleDetection>
Channel.0.OpenSDK.WiseAI.StoppedVehicleDetection=True
Channel.0.OpenSDK.WiseAI.StoppedVehicleDetection.1=True
Channel.0.OpenSDK.WiseAI.StoppedVehicleDetection=True
Channel.0.OpenSDK.WiseAI.StoppedVehicleDetection.1.VideoSourceToken=VideoSourceToken-0
Channel.0.OpenSDK.WiseAI.StoppedVehicleDetection.1.RuleName=rulename
Channel.0.OpenSDK.WiseAI.StoppedVehicleDetection.1.State=True
Channel.0.OpenSDK.WiseAI.StoppedVehicleDetection.1.VehicleTypes=Car Bus Truck Motorcycle Bicycle
Channel.0.OpenSDK.WiseAI.StoppedVehicleDetection.1.ObjectIDs=258 260 261 278 280
{
"EventName": "OpenSDK.WiseAI.StoppedVehicleDetection",
"Time": "2021-10-27T07:36:14.509+00:00",
"Source": {
"Channel": 0,
"AppName": "WiseAI",
"AppID": "WiseAI",
"AppEvent": "StoppedVehicleDetection",
"Type": "Event",
"RuleIndex": 1,
"VideoSourceToken": "VideoSourceToken-0",
"RuleName": "rulename"
},
"Data": {
"State": true,
"VehicleTypes": "Car Bus Truck Motorcycle Bicycle",
"ObjectIDs": "258 260 261 278 280"
}
}
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "stoppedVehicleDetectionConfiguration": [
- {
- "channel": 0,
- "enable": true,
- "detectionArea": [
- {
- "index": 1,
- "name": "string",
- "vehicleTypes": [
- {
- "vehicleType": "Car",
- "enable": true,
- "duration": 0,
- "durationSeconds": 0,
- "totalDurationSeconds": 0
}
], - "areaCoordinates": [
- {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}
], - "enableSchedule": true,
- "scheduleName": "string"
}
]
}
]
}Area and rule based stopped-vehicle detection configurations, a device that indicates capability of stoppedvehicledetection in getcapability command shall support this command.
| channel required | integer <int32> | ||||||||||||||||||||||||||||||
| enable | boolean | ||||||||||||||||||||||||||||||
Array of objects (StoppedVehicleDetectionArea) | |||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||
{- "channel": 0,
- "enable": true,
- "detectionArea": [
- {
- "index": 1,
- "name": "string",
- "vehicleTypes": [
- {
- "vehicleType": "Car",
- "enable": true,
- "duration": 0,
- "durationSeconds": 0,
- "totalDurationSeconds": 0
}
], - "areaCoordinates": [
- {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}
], - "enableSchedule": true,
- "scheduleName": "string"
}
]
}{- "response": "Success"
}Provide allowed values of each parameters in stopped-vehicle detection configuration. Ranges of parameters in stopped-vehicle detection configuration, a device that indicates capability of stoppedvehicledetection in getcapability command shall support this command.
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "stoppedVehicleDetectionOptions": [
- {
- "channel": 0,
- "detectionAreaOptions": [
- {
- "index": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "vehicleTypeOptions": [
- {
- "duration": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "durationSeconds": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "totalDurationSeconds": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "vehicleType": [
- "string"
]
}
], - "areaCoordinates": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}
}
]
}
]
}Delete the area for the requested index.
| channel required | integer <int32> Required channel parameter, operation is applicable only for the specified channel. |
| index required | Array of integers <int32> non-empty [ items <int32 > >= 1 ] Examples:
Required parameter, used to set a specific index. |
{- "response": "Success"
}line based traffic-jam detection configurations, a device that indicates capability of trafficjamdetection in getcapability command shall support this command. When traffic-jam detection is enabled, event is delivered in below formats,
tns1:OpenApp/WiseAI/TrafficJamDetection
<?xml version="1.0" encoding="UTF-8"?>
<TrafficJamDetection wstop:topic="true">
<tt:MessageDescription>
<tt:Source>
<tt:SimpleItemDescription Name="VideoSourceToken" Type="tt:ReferenceToken"/>
<tt:SimpleItemDescription Name="RuleName" Type="xsd:string"/>
</tt:Source>
<tt:Data>
<tt:SimpleItemDescription Name="State" Type="xsd:boolean"/>
</tt:Data>
</tt:MessageDescription>
</TrafficJamDetection>
Channel.0.OpenSDK.WiseAI.TrafficJamDetection=True
Channel.0.OpenSDK.WiseAI.TrafficJamDetection.1=True
Channel.0.OpenSDK.WiseAI.TrafficJamDetection=True
Channel.0.OpenSDK.WiseAI.TrafficJamDetection.1.VideoSourceToken=VideoSourceToken-0
Channel.0.OpenSDK.WiseAI.TrafficJamDetection.1.RuleName=rulename
Channel.0.OpenSDK.WiseAI.TrafficJamDetection.1.State=True
{
"EventName": "OpenSDK.WiseAI.TrafficJamDetection",
"Time": "2021-10-27T07:36:14.509+00:00",
"Source": {
"Channel": 0,
"AppName": "WiseAI",
"AppID": "WiseAI",
"AppEvent": "TrafficJamDetection",
"Type": "Event",
"RuleIndex": 1,
"VideoSourceToken": "VideoSourceToken-0",
"RuleName": "rulename"
},
"Data": {
"State": true
}
}
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "trafficJamDetectionConfiguration": [
- {
- "channel": 0,
- "enable": true,
- "distanceSpeedUnit": "string",
- "detectionRules": [
- {
- "index": 1,
- "name": "string",
- "lines": {
- "startLine": [
- {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}
], - "endLine": [
- {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}
]
}, - "distance": 0.1,
- "speed": 0,
- "time": 0
}
]
}
]
}line based traffic-jam detection configurations, a device that indicates capability of trafficjamdetection in getcapability command shall support this command.
| channel required | integer <int32> | ||||||||||||||||||||||||||||||
| enable | boolean | ||||||||||||||||||||||||||||||
| distanceSpeedUnit | string | ||||||||||||||||||||||||||||||
Array of objects (TrafficJamDetectionRule) | |||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||
{- "channel": 0,
- "enable": true,
- "distanceSpeedUnit": "string",
- "detectionRules": [
- {
- "index": 1,
- "name": "string",
- "lines": {
- "startLine": [
- {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}
], - "endLine": [
- {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}
]
}, - "distance": 0.1,
- "speed": 0,
- "time": 0
}
]
}{- "response": "Success"
}Provide allowed values of each parameters in traffic-jam detection configuration. Ranges of parameters in traffic-jam detection configuration, a device that indicates capability of trafficjamdetection in getcapability command shall support this command.
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "trafficJamDetectionOptions": [
- {
- "channel": 0,
- "distanceSpeedUnit": [
- "string"
], - "detectionRules": [
- {
- "index": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "lines": {
- "lineCoordinates": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}
}, - "kph": {
- "distance": {
- "min": 0.1,
- "max": 0.1,
- "step": 0.1,
- "default": 0.1
}, - "speed": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}
}, - "mph": {
- "distance": {
- "min": 0.1,
- "max": 0.1,
- "step": 0.1,
- "default": 0.1
}, - "speed": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}
}, - "time": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}
}
]
}
]
}Delete the rule for the requested index.
| channel required | integer <int32> Required channel parameter, operation is applicable only for the specified channel. |
| index required | Array of integers <int32> non-empty [ items <int32 > >= 1 ] Examples:
Required parameter, used to set a specific index. |
{- "response": "Success"
}Gets the queuemanagement configuration, suppport only if queuemanagement capability is set to true.
tns1:OpenApp/WiseAI/QueueMedium
<?xml version="1.0" encoding="UTF-8"?>
<QueueMedium wstop:topic="true">
<tt:MessageDescription IsProperty="true">
<tt:Source>
<tt:SimpleItemDescription Name="VideoSourceToken" Type="tt:ReferenceToken"/>
<tt:SimpleItemDescription Name="RuleName" Type="xsd:string"/>
</tt:Source>
<tt:Data>
<tt:SimpleItemDescription Name="State" Type="xsd:boolean"/>
</tt:Data>
</tt:MessageDescription>
</QueueMedium>
Channel.0.OpenSDK.WiseAI.QueueMedium=True
Channel.0.OpenSDK.WiseAI.QueueMedium.1=True
Channel.0.OpenSDK.WiseAI.QueueMedium=True
Channel.0.OpenSDK.WiseAI.QueueMedium.1.VideoSourceToken=VideoSourceToken-0
Channel.0.OpenSDK.WiseAI.QueueMedium.1.RuleName=RuleName1
Channel.0.OpenSDK.WiseAI.QueueMedium.1.State=True
{
"EventName": "OpenSDK.WiseAI.QueueMedium",
"Time": "2022-03-15T02:58:52.820+00:00",
"Source": {
"Channel": 0,
"AppName": "WiseAI",
"AppID": "WiseAI",
"AppEvent": "QueueMedium",
"Type": "Event",
"RuleIndex": 1,
"VideoSourceToken": "VideoSourceToken-0",
"RuleName": "rulename"
},
"Data": {
"State": true
}
}
tns1:OpenApp/WiseAI/QueueHigh
<?xml version="1.0" encoding="UTF-8"?>
<QueueHigh wstop:topic="true">
<tt:MessageDescription IsProperty="true">
<tt:Source>
<tt:SimpleItemDescription Name="VideoSourceToken" Type="tt:ReferenceToken"/>
<tt:SimpleItemDescription Name="RuleName" Type="xsd:string"/>
</tt:Source>
<tt:Data>
<tt:SimpleItemDescription Name="State" Type="xsd:boolean"/>
</tt:Data>
</tt:MessageDescription>
</QueueHigh>
Channel.0.OpenSDK.WiseAI.QueueHigh=True
Channel.0.OpenSDK.WiseAI.QueueHigh.1=True
Channel.0.OpenSDK.WiseAI.QueueHigh=True
Channel.0.OpenSDK.WiseAI.QueueHigh.1.VideoSourceToken=VideoSourceToken-0
Channel.0.OpenSDK.WiseAI.QueueHigh.1.RuleName=RuleName1
Channel.0.OpenSDK.WiseAI.QueueHigh.1.State=True
{
"EventName": "OpenSDK.WiseAI.QueueHigh",
"Time": "2022-03-15T02:58:52.820+00:00",
"Source": {
"Channel": 0,
"AppName": "WiseAI",
"AppID": "WiseAI",
"AppEvent": "QueueHigh",
"Type": "Event",
"RuleIndex": 1,
"VideoSourceToken": "VideoSourceToken-0",
"RuleName": "rulename"
},
"Data": {
"State": true
}
}
The QueueCountChanged event is generated only in JSON schema format, this event occurs only when the Count value is changed. "Count" data in ONVIF/SUNAPI event is counted over 1 second, not cumulative value. Also, if you want to know the counting result for a specific period, check the contents of "search/queuemanagement"
tns1:OpenApp/WiseAI/QueueCountChanged
<?xml version="1.0" encoding="UTF-8"?>
<QueueCountChanged wstop:topic="true">
<tt:MessageDescription>
<tt:Source>
<tt:SimpleItemDescription Name="VideoSource" Type="tt:ReferenceToken"/>
<tt:SimpleItemDescription Name="RuleName" Type="xsd:string"/>
</tt:Source>
<tt:Data>
<tt:SimpleItemDescription Name="Count" Type="xsd:integer"/>
</tt:Data>
</tt:MessageDescription>
</QueueCountChanged>
{
"EventName": "OpenSDK.WiseAI.QueueCountChanged",
"Time": "2022-03-15T02:58:52.820+00:00",
"Source": {
"Channel": 0,
"AppName": "WiseAI",
"AppID": "WiseAI",
"AppEvent": "QueueCountChanged",
"Type": "Event",
"RuleIndex": 1,
"VideoSourceToken": "VideoSourceToken-0",
"RuleName": "rulename"
},
"Data": {
"Count": 3
}
}
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "queuemanagementConfigurations": [
- {
- "channel": 0,
- "enable": true,
- "queues": [
- {
- "index": 1,
- "name": "string",
- "enable": true,
- "maxCount": 0,
- "queueAreaCoordinates": [
- {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}
], - "queueLevelHigh": {
- "count": 0,
- "enableEventNotification": true,
- "duration": 0
}, - "queueLevelMedium": {
- "count": 0,
- "enableEventNotification": true,
- "duration": 0
}
}
]
}
]
}Configures the QueueManagement settings. For the supported values refer to queuemanagement/options response.
| channel required | integer <int32> | ||||||||||||||||||||||||||||||||||||
| enable | boolean | ||||||||||||||||||||||||||||||||||||
Array of objects (QueueElement) | |||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||
{- "channel": 0,
- "enable": true,
- "queues": [
- {
- "index": 1,
- "name": "string",
- "enable": true,
- "maxCount": 0,
- "queueAreaCoordinates": [
- {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}
], - "queueLevelHigh": {
- "count": 0,
- "enableEventNotification": true,
- "duration": 0
}, - "queueLevelMedium": {
- "count": 0,
- "enableEventNotification": true,
- "duration": 0
}
}
]
}{- "response": "Success"
}Provides the supported values and ranges for the QueueManagement configuration.
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "queuemanagementConfigurationOptions": [
- {
- "channel": 0,
- "queueOptions": {
- "index": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "queueAreaCoordinates": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "queueMaxCount": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "queueLevelHighOptions": {
- "count": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "duration": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}
}, - "queueLevelMediumOptions": {
- "count": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "duration": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}
}
}
}
]
}Delete an queue area based on requested queue index.
| channel required | integer <int32> Required channel parameter, operation is applicable only for the specified channel. |
| index required | Array of integers <int32> non-empty [ items <int32 > >= 1 ] Examples:
Required parameter, used to set a specific index. |
{- "response": "Success"
}Provides the reporting configuration of queuemanagement
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "reportingConfigurations": [
- {
- "channel": 0,
- "reportingRules": [
- {
- "index": 1,
- "reportEnable": true,
- "reportFileName": "string",
- "reportFileType": "string",
- "reportingSchedule": {
- "scheduleType": "string",
- "weekDay": "SUN",
- "hour": 23,
- "minute": 59
}
}
]
}
]
}Configures the QueueManagement reporting configuration, for supported values refer to queuemanagement/report/options response.
| channel required | integer <int32> | ||||||||||||||||||||
Array of objects (RuleReportingConfiguration) | |||||||||||||||||||||
Array
| |||||||||||||||||||||
{- "channel": 0,
- "reportingRules": [
- {
- "index": 1,
- "reportEnable": true,
- "reportFileName": "string",
- "reportFileType": "string",
- "reportingSchedule": {
- "scheduleType": "string",
- "weekDay": "SUN",
- "hour": 23,
- "minute": 59
}
}
]
}{- "response": "Success"
}Provides the supported values and ranges for the QueueManagement reporting configuration.
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "reportingConfigurationOptions": [
- {
- "channel": 0,
- "ruleReportingOptions": {
- "index": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "reportFileTypes": [
- "string"
], - "reportingScheduleOptions": {
- "scheduleTypes": [
- "string"
], - "weekDays": [
- "string"
], - "hour": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "minute": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}
}
}
}
]
}Clears the QueueManagement that is stored.
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "response": "Success"
}Initiate the queuemanagement search based on search time duration and returns a search token
| channel required | integer <int32> Required channel parameter, operation is applicable only for the specified channel. |
| fromDate required | string <date-time> To filter results after the specified date time, example format 2021-07-28T04:40:16Z, if suffix Z not specified will be considered as local time. |
| toDate required | string <date-time> To filter results till the specified date time, example format 2021-07-28T04:40:16Z, if suffix Z not specified will be considered as local time. |
object (QueueSearchQueryObject) Advanced result filtering based on queue name |
{- "searchToken": "SearchToken-122212"
}Search token can be used to check if the search status is complete.
| searchToken required | string search token received after initiating search |
{- "status": "Completed"
}Client can cancel an intiated search session using this method. Should pass a valid search token to cancel.
| searchToken required | string search token received after initiating search |
{- "response": "Success"
}Once the search is complete, using the search token queuemanagement results can be retreived.
| searchToken required | string search token received after initiating search |
{- "resultInterval": "Hourly",
- "queues": [
- {
- "index": 0,
- "averagePeopleResult": [
- 0
], - "queueLevelHigh": {
- "cumulativeTimeResult": [
- 0
]
}, - "queueLevelMedium": {
- "cumulativeTimeResult": [
- 0
]
}
}
]
}Getting the live queue count
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
| index | Array of integers <int32> non-empty [ items <int32 > >= 1 ] Examples:
Optional parameter, used to set a specific index. |
{- "queueCount": [
- {
- "channel": 0,
- "queues": [
- {
- "index": 0,
- "count": 0
}
]
}
]
}Get the heatmap configuration, supported only if heatmap capability is set to true.
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "heatmapConfigurations": [
- {
- "channel": 0,
- "enable": true,
- "backgroundColorMode": "string",
- "enableManualReferenceMode": true,
- "autoReference": 0,
- "manualReference": 0,
- "excludeAreas": [
- {
- "index": 1,
- "name": "string",
- "areaCoordinates": [
- {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}
]
}
]
}
]
}Configures the heatmap settings. For the supported values refer to heatmap/options response.
| channel required | integer <int32> | ||||||||||||
| enable | boolean | ||||||||||||
| backgroundColorMode | string | ||||||||||||
| enableManualReferenceMode | boolean | ||||||||||||
| manualReference | integer <int32> | ||||||||||||
Array of objects (ExcludeAreaElement) | |||||||||||||
Array
| |||||||||||||
{- "channel": 0,
- "enable": true,
- "backgroundColorMode": "string",
- "enableManualReferenceMode": true,
- "manualReference": 0,
- "excludeAreas": [
- {
- "index": 1,
- "name": "string",
- "areaCoordinates": [
- {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}
]
}
]
}{- "response": "Success"
}Provides the supported values and ranges for the heatmap configuration.
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "heatmapConfigurationOptions": [
- {
- "channel": 0,
- "backgroundColorModes": [
- "string"
], - "manualReference": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "excludeAreaOptions": {
- "index": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "areaCoordinates": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}
}
}
]
}Delete the excludearea based on the requested exclude area index.
| channel required | integer <int32> Required channel parameter, operation is applicable only for the specified channel. |
| index required | Array of integers <int32> non-empty [ items <int32 > >= 1 ] Examples:
Required parameter, used to set a specific index. |
{- "response": "Success"
}Provides the reporting configuration of heatmap
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "reportingConfigurations": [
- {
- "channel": 0,
- "reportingRules": [
- {
- "index": 1,
- "reportEnable": true,
- "reportFileName": "string",
- "reportFileType": "string",
- "reportingSchedule": {
- "scheduleType": "string",
- "weekDay": "SUN",
- "hour": 23,
- "minute": 59
}
}
]
}
]
}Configures the heatmap reporting configuration, for supported values refer to heatmap/report/options response.
| channel required | integer <int32> | ||||||||||||||||||||
Array of objects (RuleReportingConfiguration) | |||||||||||||||||||||
Array
| |||||||||||||||||||||
{- "channel": 0,
- "reportingRules": [
- {
- "index": 1,
- "reportEnable": true,
- "reportFileName": "string",
- "reportFileType": "string",
- "reportingSchedule": {
- "scheduleType": "string",
- "weekDay": "SUN",
- "hour": 23,
- "minute": 59
}
}
]
}{- "response": "Success"
}Provides the supported values and ranges for the heatmap reporting configuration.
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "reportingConfigurationOptions": [
- {
- "channel": 0,
- "ruleReportingOptions": {
- "index": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "reportFileTypes": [
- "string"
], - "reportingScheduleOptions": {
- "scheduleTypes": [
- "string"
], - "weekDays": [
- "string"
], - "hour": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "minute": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}
}
}
}
]
}Clears the heatmap that is stored.
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "response": "Success"
}Initiate the heatmap search based on search time duration and returns a search token
| channel required | integer <int32> Required channel parameter, operation is applicable only for the specified channel. |
| fromDate required | string <date-time> To filter results after the specified date time, example format 2021-07-28T04:40:16Z, if suffix Z not specified will be considered as local time. |
| toDate required | string <date-time> To filter results till the specified date time, example format 2021-07-28T04:40:16Z, if suffix Z not specified will be considered as local time. |
| resultFormat | string Enum: "Image" "Json" Optional format parameter to get the search result in requested format. Default format is image. |
| resultImageType | string Enum: "WithBackground" "WithoutBackground" Example: resultImageType=WithBackground Optional result Image type selection, if not passed WithBackground will be selected. It's used when the resultFormat paramter is image |
{- "searchToken": "SearchToken-122212"
}Client can cancel an intiated search session using this method. Should pass a valid search token to cancel.
| searchToken required | string search token received after initiating search |
{- "response": "Success"
}Getting the live heatmap levels
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "heatmap": [
- {
- "channel": 0,
- "level": [
- 0
], - "resolution": {
- "width": 0,
- "height": 0
}, - "descriptor": 0
}
]
}Generic object counting configuration, that can be used for counting objects that crosses the configured lines. For supported objecttypes you can refer to objectcounting/options command response.
The ObjectCounting event is generated only in JSON schema format, this event occurs only when the Count value is changed.
Currently only "Punctual" ReportType is supported, but it may be extended to other ReportTypes such as "Summary" in the future.
"Count" data in ONVIF/SUNAPI event is counted over 1 second, not cumulative value.
Also, if you want to know the counting result for a specific period, check the contents of "search/objectcounting"
tns1:OpenApp/WiseAI/ObjectCounting
<?xml version="1.0" encoding="UTF-8"?>
<ObjectCounting wstop:topic="true">
<tt:MessageDescription>
<tt:Source>
<tt:SimpleItemDescription Name="VideoSource" Type="tt:ReferenceToken"/>
<tt:SimpleItemDescription Name="CountingRuleIndex" Type="xsd:integer"/>
<tt:SimpleItemDescription Name="RuleName" Type="xsd:string"/>
</tt:Source>
<tt:Data>
<tt:SimpleItemDescription Name="ReportType" Type="xsd:string"/>
<tt:SimpleItemDescription Name="ObjectType" Type="xsd:string"/>
<tt:SimpleItemDescription Name="Direction" Type="xsd:string"/>
<tt:SimpleItemDescription Name="Count" Type="xsd:integer"/>
</tt:Data>
</tt:MessageDescription>
</ObjectCounting>
{
"EventName": "OpenSDK.WiseAI.ObjectCounting",
"Time": "2022-03-15T02:58:52.820+00:00",
"Source": {
"Channel": 0,
"AppName": "WiseAI",
"AppID": "WiseAI",
"AppEvent": "ObjectCounting",
"Type": "Event",
"RuleIndex": 1,
"VideoSourceToken": "VideoSourceToken-0",
"CountingRuleIndex": 1,
"RuleName": "rulename"
},
"Data": {
"ReportType": "Punctual",
"ObjectType": "Vehicle",
"Direction": "IN",
"Count": 3
}
}
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "objectCountingConfiguration": [
- {
- "channel": 0,
- "countingRules": [
- {
- "index": 1,
- "enable": true,
- "objectType": "string",
- "lines": [
- {
- "index": 1,
- "name": "string",
- "mode": "LeftToRightIn",
- "lineCoordinates": [
- {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}
]
}
], - "excludeAreas": [
- {
- "index": 1,
- "name": "string",
- "areaCoordinates": [
- {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}
]
}
]
}
]
}
]
}Configurest the generic objectcounting rule, can be used to count objectypes provided in the objectcounting/options.
| channel required | integer <int32> | ||||||||||||||||||||||||||||
Array of objects (ObjectCountingRule) | |||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||
{- "channel": 0,
- "countingRules": [
- {
- "index": 1,
- "enable": true,
- "objectType": "string",
- "lines": [
- {
- "index": 1,
- "name": "string",
- "mode": "LeftToRightIn",
- "lineCoordinates": [
- {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}
]
}
], - "excludeAreas": [
- {
- "index": 1,
- "name": "string",
- "areaCoordinates": [
- {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}
]
}
]
}
]
}{- "response": "Success"
}Provides the values supported in objectcounting rule
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "objectCountingConfigurationOptions": [
- {
- "channel": 0,
- "countingRuleOptions": {
- "index": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "objectTypes": [
- "string"
], - "vehicleTypes": [
- "string"
], - "lineOptions": {
- "index": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "lineCoordinates": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "mode": [
- "string"
]
}, - "excludeAreaOptions": {
- "index": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "areaCoordinates": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}
}, - "indexBasedLimits": [
- {
- "index": 1,
- "objectTypes": [
- "string"
]
}
]
}
}
]
}Delete the line based on requested counting rule index and line index.
| channel required | integer <int32> Required channel parameter, operation is applicable only for the specified channel. |
| countingruleindex required | integer >= 1 counting rule index in which the line has to be deleted |
| index required | Array of integers <int32> non-empty [ items <int32 > >= 1 ] Examples:
Required parameter, used to set a specific index. |
{- "response": "Success"
}Delete the excludearea based on the requested counting rule index and exclude area index.
| channel required | integer <int32> Required channel parameter, operation is applicable only for the specified channel. |
| countingruleindex | integer >= 1 Optional counting rule index in which the exclude area has to be deleted |
| index required | Array of integers <int32> non-empty [ items <int32 > >= 1 ] Examples:
Required parameter, used to set a specific index. |
{- "response": "Success"
}Provides the reporting configuration of ObjectingCounting
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "reportingConfigurations": [
- {
- "channel": 0,
- "countingRules": [
- {
- "index": 1,
- "reportEnable": true,
- "reportFileName": "string",
- "reportFileType": "string",
- "reportingSchedule": {
- "scheduleType": "string",
- "weekDay": "SUN",
- "hour": 23,
- "minute": 59
}
}
]
}
]
}Configures the ObjectCounting reporting configuration, for supported values refer to objectcounting/report/options response.
| channel required | integer <int32> | ||||||||||||||||||||
Array of objects (OCCountingRuleReportingConfiguration) | |||||||||||||||||||||
Array
| |||||||||||||||||||||
{- "channel": 0,
- "countingRules": [
- {
- "index": 1,
- "reportEnable": true,
- "reportFileName": "string",
- "reportFileType": "string",
- "reportingSchedule": {
- "scheduleType": "string",
- "weekDay": "SUN",
- "hour": 23,
- "minute": 59
}
}
]
}{- "response": "Success"
}Provides the supported values and ranges for the objectcounting reporting configuration.
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "reportingConfigurationOptions": [
- {
- "channel": 0,
- "countingRuleReportingOptions": {
- "index": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "reportFileTypes": [
- "string"
], - "reportingScheduleOptions": {
- "scheduleTypes": [
- "string"
], - "weekDays": [
- "string"
], - "hour": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "minute": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}
}
}
}
]
}Clears the counting data that is stored.
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
| index | Array of integers <int32> non-empty [ items <int32 > >= 1 ] Examples:
Optional parameter, used to set a specific index. |
{- "response": "Success"
}Initiate the objectcounting search based on search time duration and returns a search token
| channel required | integer <int32> Required channel parameter, operation is applicable only for the specified channel. |
| fromDate required | string <date-time> To filter results after the specified date time, example format 2021-07-28T04:40:16Z, if suffix Z not specified will be considered as local time. |
| toDate required | string <date-time> To filter results till the specified date time, example format 2021-07-28T04:40:16Z, if suffix Z not specified will be considered as local time. |
| index | integer <int32> >= 1 Optional counting rule index to filter the result for the specified counting rule. |
{- "searchToken": "SearchToken-122212"
}Search token can be used to check if the search status is complete.
| searchToken required | string search token received after initiating search |
{- "status": "Completed"
}Client can cancel an intiated search session using this method. Should pass a valid search token to cancel.
| searchToken required | string search token received after initiating search |
{- "response": "Success"
}Once the search is complete, using the search token objectcounting results can be retreived.
| searchToken required | string search token received after initiating search |
| includeAIData | boolean Optional field to request AI data in the result |
{- "resultInterval": "Hourly",
- "countingRules": [
- {
- "index": 1,
- "lineBasedResults": [
- {
- "index": 1,
- "directionBasedResult": [
- {
- "direction": "IN",
- "result": [
- 0
], - "genderAgeInfo": [
- {
- "gender": [
- null
], - "age": [
- null
]
}
], - "vehicleInfo": [
- {
- "vehicleType": "Bicycle",
- "result": [
- null
]
}
]
}, - {
- "direction": "IN",
- "result": [
- 0
], - "genderAgeInfo": [
- {
- "gender": [
- null
], - "age": [
- null
]
}
], - "vehicleInfo": [
- {
- "vehicleType": "Bicycle",
- "result": [
- null
]
}
]
}
]
}
]
}
]
}Getting the live object counting data
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
| index | integer <int32> >= 1 Optional counting rule index to get the result for the specified counting rule. If index is not specified, index is specified as 1. |
| includeAIData | boolean Optional field to request AI data in the result |
{- "objectCountingLive": [
- {
- "channel": 0,
- "countingRules": [
- {
- "index": 1,
- "lines": [
- {
- "index": 1,
- "directionBasedResult": [
- {
- "direction": "IN",
- "count": 0,
- "vehicleInfo": [
- {
- "vehicleType": "Bicycle",
- "count": 0
}, - {
- "vehicleType": "Motorcycle",
- "count": 0
}, - {
- "vehicleType": "Car",
- "count": 0
}, - {
- "vehicleType": "Bus",
- "count": 0
}, - {
- "vehicleType": "Truck",
- "count": 0
}
]
}, - {
- "direction": "OUT",
- "count": 0,
- "vehicleInfo": [
- {
- "vehicleType": "Bicycle",
- "count": 0
}, - {
- "vehicleType": "Motorcycle",
- "count": 0
}, - {
- "vehicleType": "Car",
- "count": 0
}, - {
- "vehicleType": "Bus",
- "count": 0
}, - {
- "vehicleType": "Truck",
- "count": 0
}
]
}
]
}
]
}
]
}
]
}gets the slip and fall detection settings that is configured. Can check if this feature is supported from the configuration/capability response.
tns1:OpenApp/WiseAI/SlipAndFallDetection
<?xml version="1.0" encoding="UTF-8"?>
<SlipAndFallDetection wstop:topic="true">
<tt:MessageDescription>
<tt:Source>
<tt:SimpleItemDescription Name="VideoSourceToken" Type="tt:ReferenceToken"/>
<tt:SimpleItemDescription Name="RuleName" Type="xsd:string"/>
</tt:Source>
<tt:Data>
<tt:SimpleItemDescription Name="State" Type="xsd:boolean"/>
<tt:SimpleItemDescription Name="ObjectId" Type="xsd:integer"/>
</tt:Data>
</tt:MessageDescription>
</SlipAndFallDetection>
Channel.0.OpenSDK.WiseAI.SlipAndFallDetection=True
Channel.0.OpenSDK.WiseAI.SlipAndFallDetection.1=True
Channel.0.OpenSDK.WiseAI.SlipAndFallDetection=True
Channel.0.OpenSDK.WiseAI.SlipAndFallDetection.1.VideoSourceToken=VideoSourceToken-0
Channel.0.OpenSDK.WiseAI.SlipAndFallDetection.1.RuleName=RuleName1
Channel.0.OpenSDK.WiseAI.SlipAndFallDetection.1.State=True
Channel.0.OpenSDK.WiseAI.SlipAndFallDetection.1.ObjectId=1
{
"EventName": "OpenSDK.WiseAI.SlipAndFallDetection",
"Time": "2022-03-15T02:58:52.820+00:00",
"Source": {
"Channel": 0,
"AppName": "WiseAI",
"AppID": "WiseAI",
"AppEvent": "SlipAndFallDetection",
"Type": "Event",
"RuleIndex": 1,
"VideoSourceToken": "VideoSourceToken-0",
"RuleName": "rulename"
},
"Data": {
"State": true
"ObjectId": 1
}
}
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "slipAndFallDetection": [
- {
- "channel": 0,
- "enable": true,
- "detectionAreas": [
- {
- "index": 1,
- "name": "string",
- "areaCoordinates": [
- {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}
]
}
]
}
]
}Configures the slip and fall detection settings, for supported values and ranges refer to slipandfalldetection/options response.
| channel | integer <int32> | ||||||||||||
| enable | boolean | ||||||||||||
Array of objects (SlipAndFallDetectionAreaElement) | |||||||||||||
Array
| |||||||||||||
{- "channel": 0,
- "enable": true,
- "detectionAreas": [
- {
- "index": 1,
- "name": "string",
- "areaCoordinates": [
- {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}
]
}
]
}{- "response": "Success"
}Delete the area for the requested index.
| channel required | integer <int32> Required channel parameter, operation is applicable only for the specified channel. |
| index required | Array of integers <int32> non-empty [ items <int32 > >= 1 ] Examples:
Required parameter, used to set a specific index. |
{- "response": "Success"
}Supported values and ranges reguired for configuring slip and fall detection is provided in response.
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "slipAndFallDetectionOptions": [
- {
- "channel": 0,
- "detectionAreaOptions": {
- "index": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "areaCoordinates": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}
}
}
]
}Gets the list of wisedetector models available and its configuration
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "wisedetectorConfigurations": [
- {
- "channel": 0,
- "wisedetectors": [
- {
- "enable": true,
- "objectName": "string",
- "modelID": "string",
- "sensitivity": 1,
- "colorFilter": [
- {
- "rgbHexCode": "string"
}
]
}
]
}
]
}Sets the confirguration for the wisedetector of a particular channel, multiple wisedetectors can be configured at the same time. Here objectName parameter cannot be changed, to change the object name please refer to "PUT /configuration/wisedetector/model"
Please check the options reponse for the supported values.
| channel required | integer <int32> | ||||||||||||
Array of objects (wisedetector) | |||||||||||||
Array
| |||||||||||||
{- "channel": 0,
- "wisedetectors": [
- {
- "enable": true,
- "objectName": "string",
- "sensitivity": 1,
- "colorFilter": [
- {
- "rgbHexCode": "string"
}
]
}
]
}{- "response": "Success"
}Based on this response, wisedetector can be configured.
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "wisedetectorConfigurationOptions": [
- {
- "channel": 0,
- "wisedetectorOptions": {
- "objectNames": [
- "string"
], - "colorFilterOptions": {
- "colorFilterMinMax": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "supportedColors": [
- "string"
]
}
}
}
]
}Trained model data is uploaded using this api as binary file (application/octet-stream). Here channel parameter is used to associate the uploaded model file to a channel incase of multi channel camera. If the camera is single channel camera, channel '0' is used.
| objectName required | string [ 1 .. 63 ] characters Required objectName prameter. |
| channel required | integer <int32> Required channel parameter, operation is applicable only for the specified channel. |
Model file as binary content
{- "modelID": "modelInd-1",
- "modelOverwrite": true
}Delete model data based on unique modelID.
| channel required | integer <int32> Required channel parameter, operation is applicable only for the specified channel. |
| modelID required | string Required modelID prameter, unique identifier of the model data. |
{- "response": "Success"
}Get the complete list of model data available.
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "modelDataConfiguration": [
- {
- "channel": 0,
- "modelDatas": [
- {
- "modelID": "string",
- "objectName": "string"
}
]
}
]
}This api can be used to update objectName name of already uploaded model data based on modelID.
| channel | integer <int32> | ||||
Array of objects (ModelDataItem) | |||||
Array
| |||||
{- "channel": 0,
- "modelDatas": [
- {
- "modelID": "string",
- "objectName": "string"
}
]
}{- "response": "Success"
}Gets the list of flexai models available and its configuration
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "flexAIConfigurations": [
- {
- "channel": 0,
- "flexAImodels": [
- {
- "enable": true,
- "objectName": "string",
- "modelID": "string",
- "sensitivity": 1,
- "minimumObjectSizeInPixels": {
- "width": 0,
- "height": 0
}, - "maximumObjectSizeInPixels": {
- "width": 0,
- "height": 0
}
}
]
}
]
}Sets the confirguration for the flexai of a particular channel.
Please check the options reponse for the supported values.
| channel required | integer <int32> | ||||||||||||||||||||||
Array of objects (flexAImodelsEach) | |||||||||||||||||||||||
Array
| |||||||||||||||||||||||
{- "channel": 0,
- "flexAImodels": [
- {
- "enable": true,
- "objectName": "string",
- "sensitivity": 1,
- "minimumObjectSizeInPixels": {
- "width": 0,
- "height": 0
}, - "maximumObjectSizeInPixels": {
- "width": 0,
- "height": 0
}
}
]
}{- "response": "Success"
}Trained model data is uploaded using this api as tar file. Here channel parameter is used to associate the uploaded model file to a channel in case of multi channel camera. If the camera is single channel camera, channel '0' is used.
| channel required | integer <int32> Required channel parameter, operation is applicable only for the specified channel. |
Model file as binary content
{- "modelID": "modelInd-1",
- "modelOverwrite": true
}Delete model data based on unique modelID.
| channel required | integer <int32> Required channel parameter, operation is applicable only for the specified channel. |
| modelID required | string Required modelID prameter, unique identifier of the model data. |
{- "response": "Success"
}Based on this response, flexai can be configured.
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "flexAIConfigurationOptions": [
- {
- "channel": 0,
- "flexAIOptions": {
- "sensitivity": {
- "min": 0,
- "max": 0
}, - "minimumObjectSizeInPixels": {
- "width": 0,
- "height": 0
}, - "maximumObjectSizeInPixels": {
- "width": 0,
- "height": 0
}
}
}
]
}Gets the crowdcounting configuration, suppport only if crowdcounting capability is set to true.
tns1:OpenApp/WiseAI/CrowdCountDetection
<?xml version="1.0" encoding="UTF-8"?>
<CrowdCountDetection wstop:topic="true">
<tt:MessageDescription IsProperty="true">
<tt:Source>
<tt:SimpleItemDescription Name="VideoSource" Type="tt:ReferenceToken"/>
<tt:SimpleItemDescription Name="RuleName" Type="xsd:string"/>
</tt:Source>
<tt:Data>
<tt:SimpleItemDescription Name="State" Type="xsd:boolean"/>
</tt:Data>
</tt:MessageDescription>
</CrowdCountDetection>
Channel.0.OpenSDK.WiseAI.CrowdCountDetection=True
Channel.0.OpenSDK.WiseAI.CrowdCountDetection.1=True
Channel.0.OpenSDK.WiseAI.CrowdCountDetection=True
Channel.0.OpenSDK.WiseAI.CrowdCountDetection.1.VideoSourceToken=VideoSourceToken-0
Channel.0.OpenSDK.WiseAI.CrowdCountDetection.1.RuleName=RuleName1
Channel.0.OpenSDK.WiseAI.CrowdCountDetection.1.State=True
{
"EventName": "OpenSDK.WiseAI.CrowdCountDetection",
"Time": "2023-03-15T02:58:52.820+00:00",
"Source": {
"Channel": 0,
"AppName": "WiseAI",
"AppID": "WiseAI",
"AppEvent": "CrowdCountDetection",
"Type": "Event",
"RuleIndex": 1,
"VideoSourceToken": "VideoSourceToken-0",
"RuleName": "rulename"
},
"Data": {
"State": true
}
}
The CrowdCountChanged event is generated only in JSON schema format, this event occurs only when the Count value is changed. "Count" data in ONVIF/SUNAPI event is counted over 1 second, not cumulative value.
tns1:OpenApp/WiseAI/CrowdCountChanged
<?xml version="1.0" encoding="UTF-8"?>
<CrowdCountChanged wstop:topic="true">
<tt:MessageDescription>
<tt:Source>
<tt:SimpleItemDescription Name="VideoSource" Type="tt:ReferenceToken"/>
<tt:SimpleItemDescription Name="RuleName" Type="xsd:string"/>
</tt:Source>
<tt:Data>
<tt:SimpleItemDescription Name="Count" Type="xsd:integer"/>
</tt:Data>
</tt:MessageDescription>
</CrowdCountChanged>
{
"EventName": "OpenSDK.WiseAI.CrowdCountChanged",
"Time": "2023-03-15T02:58:52.820+00:00",
"Source": {
"Channel": 0,
"AppName": "WiseAI",
"AppID": "WiseAI",
"AppEvent": "CrowdCountChanged",
"Type": "Event",
"RuleIndex": 1,
"VideoSourceToken": "VideoSourceToken-0",
"RuleName": "rulename"
},
"Data": {
"Count": 3
}
}
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "crowdcountingConfigurations": [
- {
- "channel": 0,
- "enable": true,
- "areas": [
- {
- "index": 1,
- "name": "string",
- "enable": true,
- "threshold": 0,
- "duration": 0,
- "areaCoordinates": [
- {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}
]
}
]
}
]
}Configures the CrowdCounting settings. For the supported values refer to crowdcounting/options response.
| channel required | integer <int32> | ||||||||||||||||||
| enable | boolean | ||||||||||||||||||
Array of objects (CrowdCoutingAreaElement) | |||||||||||||||||||
Array
| |||||||||||||||||||
{- "channel": 0,
- "enable": true,
- "areas": [
- {
- "index": 1,
- "name": "string",
- "enable": true,
- "threshold": 0,
- "duration": 0,
- "areaCoordinates": [
- {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}
]
}
]
}{- "response": "Success"
}Provides the supported values and ranges for the CrowdCounting configuration.
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "crowdcountingConfigurationOptions": [
- {
- "channel": 0,
- "areaOptions": {
- "index": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "threshold": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "duration": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "areaCoordinates": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}
}
}
]
}Delete an area based on requested area index.
| channel required | integer <int32> Required channel parameter, operation is applicable only for the specified channel. |
| index required | Array of integers <int32> non-empty [ items <int32 > >= 1 ] Examples:
Required parameter, used to set a specific index. |
{- "response": "Success"
}Provides the reporting configuration of crowdcounting
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "reportingConfigurations": [
- {
- "channel": 0,
- "reportingRules": [
- {
- "index": 1,
- "reportEnable": true,
- "reportFileName": "string",
- "reportFileType": "string",
- "reportingSchedule": {
- "scheduleType": "string",
- "weekDay": "SUN",
- "hour": 23,
- "minute": 59
}
}
]
}
]
}Configures the Crowdcounting reporting configuration, for supported values refer to crowdcounting/report/options response.
| channel required | integer <int32> | ||||||||||||||||||||
Array of objects (RuleReportingConfiguration) | |||||||||||||||||||||
Array
| |||||||||||||||||||||
{- "channel": 0,
- "reportingRules": [
- {
- "index": 1,
- "reportEnable": true,
- "reportFileName": "string",
- "reportFileType": "string",
- "reportingSchedule": {
- "scheduleType": "string",
- "weekDay": "SUN",
- "hour": 23,
- "minute": 59
}
}
]
}{- "response": "Success"
}Provides the supported values and ranges for the Crowdcounting reporting configuration.
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "reportingConfigurationOptions": [
- {
- "channel": 0,
- "ruleReportingOptions": {
- "index": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "reportFileTypes": [
- "string"
], - "reportingScheduleOptions": {
- "scheduleTypes": [
- "string"
], - "weekDays": [
- "string"
], - "hour": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "minute": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}
}
}
}
]
}Clears the Crowdcounting that is stored.
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "response": "Success"
}Getting the live crowd counting data
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
| index | integer <int32> >= 1 Optional counting rule index to filter the result for the specified counting rule. |
{- "crowdCountingLive": [
- {
- "channel": 0,
- "countingRules": [
- {
- "index": 1,
- "count": 0
}
]
}
]
}Get the dynamic privacy mask event configurations, a device that indicates capability of dynamicprivacymask in getcapability command shall support this command.
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "configurations": [
- {
- "channel": 0,
- "enable": true,
- "objectTypes": [
- "string"
], - "maskType": "string",
- "color": "string",
- "mosaic": "string"
}
]
}dynamic privacy mask setting, a device that indicates capability of dynamicprivacymask in getcapability command shall support this command.
| channel required | integer <int32> |
| enable | boolean |
| objectTypes | Array of strings List of objectTypes to be masked, supported list is provided in options. Eg, Face, Vehicle, Person etc., |
| maskType | string |
| color | string |
| mosaic | string |
{- "channel": 0,
- "enable": true,
- "objectTypes": [
- "string"
], - "maskType": "string",
- "color": "string",
- "mosaic": "string"
}{- "response": "Success"
}Get the dynamic privacy mask configurations options, a device that indicates capability of dynamicprivacymask in getcapability command shall support this command.
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "options": [
- {
- "channel": 0,
- "objectTypes": [
- "string"
], - "maskType": [
- "string"
], - "color": [
- "string"
], - "mosaic": [
- "string"
]
}
]
}To get the dataserver configuration. Data server configuration to which app connects, a device that indicates capability of dataserver in getcapability command shall support this command.
{- "enable": true,
- "ipAddress": "192.168.0.1",
- "port": 1,
- "id": "string",
- "password": "pa$$word",
- "encryptedPassword": "string",
- "storeName": "string"
}To set the dataServer configuration. Configures the datasever settting, a device that indicates capability of dataserver in getcapability command shall support this command.
| isPasswordEncrypted | boolean Optional parameter, when passed as true the password field is encrypted using the RSA Public Key, If not passed it would be considered as plain text password. |
| enable | boolean |
| ipAddress | string <ipv4> |
| port | integer <int32> [ 1 .. 65535 ] |
| id | string [ 1 .. 15 ] characters |
| password | string <password> [ 4 .. 31 ] characters Plain text password |
| encryptedPassword | string non-empty Encrypted password, this parameter must be used instead of 'password' if isPasswordEncrypted is requested as true in the query parameter |
| storeName | string [ 1 .. 20 ] characters |
{- "enable": true,
- "ipAddress": "192.168.0.1",
- "port": 1,
- "id": "string",
- "password": "pa$$word",
- "encryptedPassword": "string",
- "storeName": "string"
}{- "response": "Success"
}To test the dataserver connection status. Data server connection status, a device that indicates capability of dataserver in getcapability command shall support this command.
{- "connectionState": "Failed"
}To get the schedule configuration. Schedule configuration to which app connects, a device that indicates capability of schedule in getcapability command shall support this command.
{- "schedules": [
- {
- "index": 1,
- "name": "string",
- "fixed": true,
- "schedule": {
- "sun": [
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string"
], - "mon": [
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string"
], - "tue": [
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string"
], - "wed": [
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string"
], - "thu": [
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string"
], - "fri": [
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string"
], - "sat": [
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string"
]
}
}
]
}To set the schedule configuration. a device that indicates capability of schedule in getcapability command shall support this command.
required | Array of objects (ScheduleElement) <= 32 items | ||||||||||||||||||||||
Array (<= 32 items)
| |||||||||||||||||||||||
{- "schedules": [
- {
- "index": 1,
- "name": "string",
- "schedule": {
- "sun": [
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string"
], - "mon": [
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string"
], - "tue": [
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string"
], - "wed": [
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string"
], - "thu": [
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string"
], - "fri": [
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string"
], - "sat": [
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string",
- "string"
]
}
}
]
}{- "response": "Success"
}Delete a schedule based on requested schedule index.
| index required | Array of integers <int32> non-empty [ items <int32 > >= 1 ] Examples:
Required parameter, used to set a specific index. |
{- "response": "Success"
}Get schedule configurations options, a device that indicates capability of schedule in getcapability command shall support this command.
{- "index": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "name": {
- "minLength": 0,
- "maxLength": 0
}
}To get the current common settings configured for analytics
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "commonSetup": [
- {
- "channel": 0,
- "sensitivity": 5,
- "minimumObjectSize": {
- "width": 0,
- "height": 0
}, - "maximumObjectSize": {
- "width": 99,
- "height": 99
}, - "minimumObjectSizeInPixels": {
- "width": 0,
- "height": 0
}, - "maximumObjectSizeInPixels": {
- "width": 1920,
- "height": 1080
}
}, - {
- "channel": 1,
- "sensitivity": 5,
- "minimumObjectSize": {
- "width": 0,
- "height": 0
}, - "maximumObjectSize": {
- "width": 99,
- "height": 99
}, - "minimumObjectSizeInPixels": {
- "width": 0,
- "height": 0
}, - "maximumObjectSizeInPixels": {
- "width": 1920,
- "height": 1080
}
}
]
}Configures the common analytics settings
| channel required | integer <int32> | ||||
| sensitivity | integer <int32> [ 1 .. 100 ] Higher the number higher the sensitivity. | ||||
object (ObjectSize) | |||||
| |||||
object (ObjectSize) | |||||
| |||||
object (ObjectSizeInPixels) | |||||
| |||||
object (ObjectSizeInPixels) | |||||
| |||||
{- "channel": 0,
- "sensitivity": 1,
- "minimumObjectSize": {
- "width": 99,
- "height": 99
}, - "maximumObjectSize": {
- "width": 99,
- "height": 99
}, - "minimumObjectSizeInPixels": {
- "width": 0,
- "height": 0
}, - "maximumObjectSizeInPixels": {
- "width": 0,
- "height": 0
}
}{- "response": "Success"
}Provide allowed values of each parameters in commonanalyticssettings configuration. Ranges of parameters and max supported regions are provided here
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "commonSetupOptions": [
- {
- "channel": 0,
- "minimumObjectSizeInPixels": {
- "width": 0,
- "height": 0
}, - "maximumObjectSizeInPixels": {
- "width": 0,
- "height": 0
}
}
]
}RSA Public Key in PKCS1 or X509 Format, this can be used to encrypt password.
| format | string Enum: "PKCS1" "X509" Example: format=X509 Optional format parameter to get the public key in requested format. Default format is PKCS1. |
{- "response": "Fail",
- "error": {
- "code": 607,
- "details": "Unknown Error"
}
}The date and time information are provided in both local time and UTC time.
{- "localTime": "2019-08-24T14:15:22Z",
- "utcTime": "2019-08-24T14:15:22Z",
- "dstEnable": true,
- "timezone": "string"
}To get the eventlog of all the events, filtering is possible based on time range and eventtype. A device that indicates capability of eventlog in getcapability command shall support this command.
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
| type | Array of strings non-empty Optional type parameter to pass the event types to be filtered, refer to capability eventLogTypes field for the supported values. |
| fromDate | string <date-time> Optional parameter, to filter results after the specified date time, example format 2021-07-28T04:40:16Z, if suffix Z not specified will be considered as local time. |
| toDate | string <date-time> Optional parameter, to filter results till the specified date time, example format 2021-07-28T04:40:16Z, if suffix Z not specified will be considered as local time. |
{- "eventLogDatas": [
- {
- "channel": 0,
- "logs": [
- {
- "date": "2019-08-24T14:15:22Z",
- "type": "string",
- "description": "string"
}
]
}
]
}To get the system log, filtering is possible based on time range and logtype. A device that indicates capability of systemlog in getcapability command shall support this command.
| type | Array of strings non-empty Optional type parameter to pass the system log type to be filtered, refer to capability systemLogTypes field for the supported values. |
| fromDate | string <date-time> Optional parameter, to filter results after the specified date time, example format 2021-07-28T04:40:16Z, if suffix Z not specified will be considered as local time. |
| toDate | string <date-time> Optional parameter, to filter results till the specified date time, example format 2021-07-28T04:40:16Z, if suffix Z not specified will be considered as local time. |
{- "logs": [
- {
- "date": "2019-08-24T14:15:22Z",
- "type": "string",
- "description": "string"
}
]
}To restore the app settings. configuration backup file can be sent to app to restore its settings from backup file (as application/octet-stream)
Backup file as binary content
{- "response": "Success"
}{- "licences": [
- {
- "activationState": "string",
- "activationType": "Online",
- "licenseType": "string",
- "expirationDate": "2019-08-24T14:15:22Z",
- "licenseKey": "string",
- "requestCode": "string",
- "activationCode": "string",
- "licenseGroup": "Application",
- "featureList": [
- "string"
], - "modelName": "string"
}
]
}Get offline activation information for the entered license key
| licenseKey required | string [ 1 .. 40 ] characters License Key |
{- "requestCode": "string",
- "qrImagePath": "string",
- "activationUrl": "string"
}Request license activation
| activationType required | string Enum: "Online" "Offline" "OfflineWithFile" Depending on the activation type selected, the parameters are used as shown below and the rest are ignored
|
| licenseKey | string |
| requestCode | string |
| activationCode | string |
| licenseFile | string <byte> |
{- "activationType": "Online",
- "licenseKey": "string",
- "requestCode": "string",
- "activationCode": "string",
- "licenseFile": "string"
}{- "response": "Success"
}To get the sightmind configuration. Sightmind configuration to which app connects, a device that indicates capability of sightmind in getcapability command shall support this command.
{- "enable": true
}To set the sightmind configuration. Configures the sightmind settting, a device that indicates capability of sightmind in getcapability command shall support this command.
| enable | boolean |
{- "enable": true
}{- "response": "Success"
}Gets the Blocked Exit Detection configuration, suppport only if blockedexitdetection capability is set to true.
tns1:OpenApp/WiseAI/BlockedExitDetection
<?xml version="1.0" encoding="UTF-8"?>
<BlockedExitDetection wstop:topic="true">
<tt:MessageDescription IsProperty="true">
<tt:Source>
<tt:SimpleItemDescription Name="VideoSourceToken" Type="tt:ReferenceToken"/>
<tt:SimpleItemDescription Name="RuleName" Type="xsd:string"/>
</tt:Source>
<tt:Data>
<tt:SimpleItemDescription Name="State" Type="xsd:boolean"/>
</tt:Data>
</tt:MessageDescription>
</BlockedExitDetection>
Channel.0.OpenSDK.WiseAI.BlockedExitDetection=True
Channel.0.OpenSDK.WiseAI.BlockedExitDetection.1=True
Channel.0.OpenSDK.WiseAI.BlockedExitDetection=True
Channel.0.OpenSDK.WiseAI.BlockedExitDetection.1.VideoSourceToken=VideoSourceToken-0
Channel.0.OpenSDK.WiseAI.BlockedExitDetection.1.RuleName=RuleName1
Channel.0.OpenSDK.WiseAI.BlockedExitDetection.1.State=True
{
"EventName": "OpenSDK.WiseAI.BlockedExitDetection",
"Time": "2023-03-15T02:58:52.820+00:00",
"Source": {
"Channel": 0,
"AppName": "WiseAI",
"AppID": "WiseAI",
"AppEvent": "BlockedExitDetection",
"Type": "Event",
"RuleIndex": 1,
"VideoSourceToken": "VideoSourceToken-0",
"RuleName": "RuleName1"
},
"Data": {
"State": true
}
}
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "configurations": [
- {
- "channel": 0,
- "enable": true,
- "areas": [
- {
- "index": 1,
- "name": "string",
- "areaCoordinates": [
- {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}
], - "duration": 0,
- "sensitivity": 1,
- "referenceImageReady": true
}
]
}
]
}Configures the Blocked Exit Detection settings. For the supported values refer to blockedexitdetection/options response.
| channel | integer <int32> | ||||||||||||||||
| enable | boolean | ||||||||||||||||
Array of objects (BlockedExitDetectionAreaElement) | |||||||||||||||||
Array
| |||||||||||||||||
{- "channel": 0,
- "enable": true,
- "areas": [
- {
- "index": 1,
- "name": "string",
- "areaCoordinates": [
- {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}
], - "duration": 0,
- "sensitivity": 1
}
]
}{- "response": "Success"
}To make reference image, it takes some time. So client needs to check status of making image by GET '/configuration/blockedexitdetection' 'referenceImageReady' parameter.
| index required | integer Required index prameter. |
| channel required | integer <int32> Required channel parameter, operation is applicable only for the specified channel. |
<png image binary>
Provides the supported values and ranges for the Blocked Exit Detection configuration.
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "detectionOptions": [
- {
- "channel": 0,
- "areaOptions": {
- "index": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "areaCoordinates": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "duration": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}
}
}
]
}Delete an area based on requested area index.
| channel required | integer <int32> Required channel parameter, operation is applicable only for the specified channel. |
| index required | Array of integers <int32> non-empty [ items <int32 > >= 1 ] Examples:
Required parameter, used to set a specific index. |
{- "response": "Success"
}Gets the ATM Hook & Chain Event Detection configuration, suppport only if atmhookchaindetection capability is set to true.
tns1:OpenApp/WiseAI/ATMHookChainDetection
<?xml version="1.0" encoding="UTF-8"?>
<ATMHookChainDetection wstop:topic="true">
<tt:MessageDescription IsProperty="true">
<tt:Source>
<tt:SimpleItemDescription Name="VideoSourceToken" Type="tt:ReferenceToken"/>
<tt:SimpleItemDescription Name="RuleName" Type="xsd:string"/>
</tt:Source>
<tt:Data>
<tt:SimpleItemDescription Name="State" Type="xsd:boolean"/>
</tt:Data>
</tt:MessageDescription>
</ATMHookChainDetection>
Channel.0.OpenSDK.WiseAI.ATMHookChainDetection=True
Channel.0.OpenSDK.WiseAI.ATMHookChainDetection.1=True
Channel.0.OpenSDK.WiseAI.ATMHookChainDetection=True
Channel.0.OpenSDK.WiseAI.ATMHookChainDetection.1.VideoSourceToken=VideoSourceToken-0
Channel.0.OpenSDK.WiseAI.ATMHookChainDetection.1.RuleName=RuleName1
Channel.0.OpenSDK.WiseAI.ATMHookChainDetection.1.State=True
{
"EventName": "OpenSDK.WiseAI.ATMHookChainDetection",
"Time": "2023-03-15T02:58:52.820+00:00",
"Source": {
"Channel": 0,
"AppName": "WiseAI",
"AppID": "WiseAI",
"AppEvent": "ATMHookChainDetection",
"Type": "Event",
"RuleIndex": 1,
"VideoSourceToken": "VideoSourceToken-0",
"RuleName": "RuleName1"
},
"Data": {
"State": true
}
}
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "configurations": [
- {
- "channel": 0,
- "enable": true,
- "areas": [
- {
- "index": 1,
- "name": "string",
- "areaCoordinates": [
- {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}
], - "innerAreas": [
- {
- "areaCoordinates": [
- {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}
]
}
], - "minimumDuration": 0,
- "condition": "string",
- "normalVehicleFlow": "string"
}
]
}
]
}Configures the ATM Hook & Chain Event Detection settings. For the supported values refer to atmhookchaindetection/options response.
| channel | integer <int32> | ||||||||||||||||||||||||
| enable | boolean | ||||||||||||||||||||||||
Array of objects (ATMHookChainDetectionAreaElement) | |||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||
{- "channel": 0,
- "enable": true,
- "areas": [
- {
- "index": 1,
- "name": "string",
- "areaCoordinates": [
- {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}
], - "innerAreas": [
- {
- "areaCoordinates": [
- {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}
]
}
], - "minimumDuration": 0,
- "condition": "string",
- "normalVehicleFlow": "string"
}
]
}{- "response": "Success"
}Provides the supported values and ranges for the ATM Hook & Chain Event Detection configuration.
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "options": [
- {
- "channel": 0,
- "areaOptions": {
- "index": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "areaCoordinates": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "innerAreas": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "innerAreaCoordinates": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "minimumDuration": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "condition": [
- "string"
], - "normalVehicleFlow": [
- "string"
]
}
}
]
}Delete an area based on requested area index.
| channel required | integer <int32> Required channel parameter, operation is applicable only for the specified channel. |
| index required | Array of integers <int32> non-empty [ items <int32 > >= 1 ] Examples:
Required parameter, used to set a specific index. |
{- "response": "Success"
}Gets the Loitering Detection configuration, suppport only if loiteringdetection capability is set to true.
tns1:OpenApp/WiseAI/LoiteringDetection
<?xml version="1.0" encoding="UTF-8"?>
<LoiteringDetection wstop:topic="true">
<tt:MessageDescription IsProperty="true">
<tt:Source>
<tt:SimpleItemDescription Name="VideoSourceToken" Type="tt:ReferenceToken"/>
<tt:SimpleItemDescription Name="RuleName" Type="xsd:string"/>
</tt:Source>
<tt:Data>
<tt:SimpleItemDescription Name="State" Type="xsd:boolean"/>
</tt:Data>
</tt:MessageDescription>
</LoiteringDetection>
Channel.0.OpenSDK.WiseAI.LoiteringDetection=True
Channel.0.OpenSDK.WiseAI.LoiteringDetection.1=True
Channel.0.OpenSDK.WiseAI.LoiteringDetection=True
Channel.0.OpenSDK.WiseAI.LoiteringDetection.1.VideoSourceToken=VideoSourceToken-0
Channel.0.OpenSDK.WiseAI.LoiteringDetection.1.RuleName=RuleName1
Channel.0.OpenSDK.WiseAI.LoiteringDetection.1.State=True
{
"EventName": "OpenSDK.WiseAI.LoiteringDetection",
"Time": "2023-03-15T02:58:52.820+00:00",
"Source": {
"Channel": 0,
"AppName": "WiseAI",
"AppID": "WiseAI",
"AppEvent": "LoiteringDetection",
"Type": "Event",
"RuleIndex": 1,
"VideoSourceToken": "VideoSourceToken-0",
"RuleName": "RuleName1"
},
"Data": {
"State": true
}
}
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "configurations": [
- {
- "channel": 0,
- "enable": true,
- "areas": [
- {
- "index": 1,
- "name": "string",
- "areaCoordinates": [
- {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}
], - "innerAreas": [
- {
- "areaCoordinates": [
- {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}
]
}
], - "minimumDuration": 0
}
]
}
]
}Configures the Loitering Detection settings. For the supported values refer to loiteringdetection/options response.
| channel | integer <int32> | ||||||||||||||||||||
| enable | boolean | ||||||||||||||||||||
Array of objects (LoiteringDetectionAreaElement) | |||||||||||||||||||||
Array
| |||||||||||||||||||||
{- "channel": 0,
- "enable": true,
- "areas": [
- {
- "index": 1,
- "name": "string",
- "areaCoordinates": [
- {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}
], - "innerAreas": [
- {
- "areaCoordinates": [
- {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}
]
}
], - "minimumDuration": 0
}
]
}{- "response": "Success"
}Provides the supported values and ranges for the Loitering Detection configuration.
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "options": [
- {
- "channel": 0,
- "areaOptions": {
- "index": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "areaCoordinates": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "innerAreas": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "innerAreaCoordinates": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "minimumDuration": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}
}
}
]
}Delete an area based on requested area index.
| channel required | integer <int32> Required channel parameter, operation is applicable only for the specified channel. |
| index required | Array of integers <int32> non-empty [ items <int32 > >= 1 ] Examples:
Required parameter, used to set a specific index. |
{- "response": "Success"
}Gets the proximity detection settings, suppport only if proximitydetection capability is set to true.
tns1:OpenApp/WiseAI/ProximityDetection
<?xml version="1.0" encoding="UTF-8"?>
<ProximityDetection wstop:topic="true">
<tt:MessageDescription>
<tt:Source>
<tt:SimpleItemDescription Name="VideoSourceToken" Type="tt:ReferenceToken"/>
<tt:SimpleItemDescription Name="RuleName" Type="xsd:string"/>
</tt:Source>
<tt:Data>
<tt:SimpleItemDescription Name="State" Type="xsd:boolean"/>
<tt:SimpleItemDescription Name="ObjectId" Type="tt:StringList"/>
</tt:Data>
</tt:MessageDescription>
</ProximityDetection>
Channel.0.OpenSDK.WiseAI.ProximityDetection=True
Channel.0.OpenSDK.WiseAI.ProximityDetection.1=True
Channel.0.OpenSDK.WiseAI.ProximityDetection=True
Channel.0.OpenSDK.WiseAI.ProximityDetection.1.VideoSourceToken=VideoSourceToken-0
Channel.0.OpenSDK.WiseAI.ProximityDetection.1.RuleName=RuleName1
Channel.0.OpenSDK.WiseAI.ProximityDetection.1.State=True
Channel.0.OpenSDK.WiseAI.ProximityDetection.1.ObjectId=1234 1235
{
"EventName": "OpenSDK.WiseAI.ProximityDetection",
"Time": "2022-03-15T02:58:52.820+00:00",
"Source": {
"Channel": 0,
"AppName": "WiseAI",
"AppID": "WiseAI",
"AppEvent": "ProximityDetection",
"Type": "Event",
"RuleIndex": 1,
"VideoSourceToken": "VideoSourceToken-0",
"RuleName": "rulename"
},
"Data": {
"State": true,
"ObjectId": "1234 1235"
}
}
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "proximityDetection": [
- {
- "channel": 0,
- "enable": true,
- "distanceSpeedUnit": "string",
- "cameraHeight": 0.1,
- "tilt": 0.1,
- "roll": 0.1,
- "focalLength": 0.1,
- "rules": [
- {
- "index": 1,
- "name": "string",
- "objectTypes": [
- "string",
- "string"
], - "minimumDistance": 0.1,
- "duration": 0
}
]
}
]
}Configures the proximity detection settings, for supported values and ranges refer to proximitydetection/options response.
| channel | integer <int32> | ||||||||||
| enable | boolean | ||||||||||
| distanceSpeedUnit | string | ||||||||||
| cameraHeight | number <double> Camera height from floor (unit depends on distanceSpeedUnit setting) | ||||||||||
| tilt | number <double> | ||||||||||
| roll | number <double> | ||||||||||
| focalLength | number <double> | ||||||||||
Array of objects (ProximityDetectionRuleElement) | |||||||||||
Array
| |||||||||||
{- "channel": 0,
- "enable": true,
- "distanceSpeedUnit": "string",
- "cameraHeight": 0.1,
- "tilt": 0.1,
- "roll": 0.1,
- "focalLength": 0.1,
- "rules": [
- {
- "index": 1,
- "name": "string",
- "objectTypes": [
- "string",
- "string"
], - "minimumDistance": 0.1,
- "duration": 0
}
]
}{- "response": "Success"
}Delete the rule for the requested index.
| channel required | integer <int32> Required channel parameter, operation is applicable only for the specified channel. |
| index required | Array of integers <int32> non-empty [ items <int32 > >= 1 ] Examples:
Required parameter, used to set a specific index. |
{- "response": "Success"
}Supported values and ranges reguired for configuring proximity detection is provided in response.
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "detectionOptions": [
- {
- "channel": 0,
- "index": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "objectTypes": [
- "string"
], - "distanceSpeedUnit": [
- "string"
], - "tilt": {
- "min": 0.1,
- "max": 0.1,
- "step": 0.1,
- "default": 0.1
}, - "roll": {
- "min": 0.1,
- "max": 0.1,
- "step": 0.1,
- "default": 0.1
}, - "focalLength": {
- "min": 0.1,
- "max": 0.1,
- "step": 0.1,
- "default": 0.1
}, - "duration": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "kph": {
- "cameraHeight": {
- "min": 0.1,
- "max": 0.1,
- "step": 0.1,
- "default": 0.1
}, - "minimumDistance": {
- "min": 0.1,
- "max": 0.1,
- "step": 0.1,
- "default": 0.1
}
}, - "mph": {
- "cameraHeight": {
- "min": 0.1,
- "max": 0.1,
- "step": 0.1,
- "default": 0.1
}, - "minimumDistance": {
- "min": 0.1,
- "max": 0.1,
- "step": 0.1,
- "default": 0.1
}
}
}
]
}Gets the fire detection configuration, suppport only if firedetection capability is set to true.
tns1:OpenApp/WiseAI/FireDetection
<?xml version="1.0" encoding="UTF-8"?>
<FireDetection wstop:topic="true">
<tt:MessageDescription IsProperty="true">
<tt:Source>
<tt:SimpleItemDescription Name="VideoSourceToken" Type="tt:ReferenceToken"/>
<tt:SimpleItemDescription Name="RuleName" Type="xsd:string"/>
</tt:Source>
<tt:Data>
<tt:SimpleItemDescription Name="Score" Type="xsd:float"/>
<tt:SimpleItemDescription Name="State" Type="xsd:boolean"/>
</tt:Data>
</tt:MessageDescription>
</FireDetection>
Channel.0.OpenSDK.WiseAI.FireDetection=True
Channel.0.OpenSDK.WiseAI.FireDetection.1=True
Channel.0.OpenSDK.WiseAI.FireDetection=True
Channel.0.OpenSDK.WiseAI.FireDetection.1.VideoSourceToken=VideoSourceToken-0
Channel.0.OpenSDK.WiseAI.FireDetection.1.RuleName=RuleName1
Channel.0.OpenSDK.WiseAI.FireDetection.1.Score=0.5
Channel.0.OpenSDK.WiseAI.FireDetection.1.State=True
{
"EventName": "OpenSDK.WiseAI.FireDetection",
"Time": "2023-03-15T02:58:52.820+00:00",
"Source": {
"Channel": 0,
"AppName": "WiseAI",
"AppID": "WiseAI",
"AppEvent": "FireDetection",
"Type": "Event",
"RuleIndex": 1,
"VideoSourceToken": "VideoSourceToken-0",
"RuleName": "RuleName1"
},
"Data": {
"Score": 0.5,
"State": true
}
}
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "configurations": [
- {
- "channel": 0,
- "enable": true,
- "sensitivity": 0,
- "areas": [
- {
- "index": 1,
- "name": "string",
- "areaCoordinates": [
- {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}
], - "duration": 0
}
]
}
]
}Configures the fire detection settings. For the supported values refer to firedetection/options response.
| channel | integer <int32> | ||||||||||||||
| enable | boolean | ||||||||||||||
| sensitivity | integer <int32> Higher the number higher the sensitivity, refer to corresponding options for valid range. | ||||||||||||||
Array of objects (FireDetectionAreaElement) | |||||||||||||||
Array
| |||||||||||||||
{- "channel": 0,
- "enable": true,
- "sensitivity": 0,
- "areas": [
- {
- "index": 1,
- "name": "string",
- "areaCoordinates": [
- {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}
], - "duration": 0
}
]
}{- "response": "Success"
}Provides the supported values and ranges for the fire detection configuration.
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "detectionOptions": [
- {
- "channel": 0,
- "sensitivity": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "areaOptions": {
- "index": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "areaCoordinates": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "duration": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}
}
}
]
}Delete an area based on requested area index.
| channel required | integer <int32> Required channel parameter, operation is applicable only for the specified channel. |
| index required | Array of integers <int32> non-empty [ items <int32 > >= 1 ] Examples:
Required parameter, used to set a specific index. |
{- "response": "Success"
}Gets the fallen object detection configuration, suppport only if fallenobjectdetection capability is set to true.
tns1:OpenApp/WiseAI/FallenObjectDetection
<?xml version="1.0" encoding="UTF-8"?>
<FallenObjectDetection wstop:topic="true">
<tt:MessageDescription IsProperty="true">
<tt:Source>
<tt:SimpleItemDescription Name="VideoSourceToken" Type="tt:ReferenceToken"/>
<tt:SimpleItemDescription Name="RuleName" Type="xsd:string"/>
</tt:Source>
<tt:Data>
<tt:SimpleItemDescription Name="State" Type="xsd:boolean"/>
<tt:SimpleItemDescription Name="NormalizedCoordinates" Type="xsd:string"/>
</tt:Data>
</tt:MessageDescription>
</FallenObjectDetection>
Channel.0.OpenSDK.WiseAI.FallenObjectDetection=True
Channel.0.OpenSDK.WiseAI.FallenObjectDetection.1=True
Channel.0.OpenSDK.WiseAI.FallenObjectDetection=True
Channel.0.OpenSDK.WiseAI.FallenObjectDetection.1.VideoSourceToken=VideoSourceToken-0
Channel.0.OpenSDK.WiseAI.FallenObjectDetection.1.RuleName=RuleName1
Channel.0.OpenSDK.WiseAI.FallenObjectDetection.1.State=True
Channel.0.OpenSDK.WiseAI.FallenObjectDetection.1.NormalizedCoordinates=-0.5,0.5,0.5,0.5,0.5,-0.5,-0.5,-0.5
{
"EventName": "OpenSDK.WiseAI.FallenObjectDetection",
"Time": "2023-03-15T02:58:52.820+00:00",
"Source": {
"Channel": 0,
"AppName": "WiseAI",
"AppID": "WiseAI",
"AppEvent": "FallenObjectDetection",
"Type": "Event",
"RuleIndex": 1,
"VideoSourceToken": "VideoSourceToken-0",
"RuleName": "RuleName1"
},
"Data": {
"State": true,
"NormalizedCoordinates": "-0.5,0.5,0.5,0.5,0.5,-0.5,-0.5,-0.5"
}
}
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "configurations": [
- {
- "channel": 0,
- "enable": true,
- "areas": [
- {
- "index": 1,
- "name": "string",
- "areaCoordinates": [
- {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}
], - "duration": 0,
- "sensitivity": 0
}
]
}
]
}Configures the fallen object detection settings. For the supported values refer to fallenobjectdetection/options response.
| channel | integer <int32> | ||||||||||||||||
| enable | boolean | ||||||||||||||||
Array of objects (FallenObjectDetectionAreaElement) | |||||||||||||||||
Array
| |||||||||||||||||
{- "channel": 0,
- "enable": true,
- "areas": [
- {
- "index": 1,
- "name": "string",
- "areaCoordinates": [
- {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}
], - "duration": 0,
- "sensitivity": 0
}
]
}{- "response": "Success"
}Provides the supported values and ranges for the fallen object detection configuration.
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "detectionOptions": [
- {
- "channel": 0,
- "areaOptions": {
- "index": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "areaCoordinates": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "duration": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "sensitivity": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}
}
}
]
}Delete an area based on requested area index.
| channel required | integer <int32> Required channel parameter, operation is applicable only for the specified channel. |
| index required | Array of integers <int32> non-empty [ items <int32 > >= 1 ] Examples:
Required parameter, used to set a specific index. |
{- "response": "Success"
}Gets the shopping cart queue qanagement configuration, suppport only if shoppingcartqueuemanagement capability is set to true. This configuration is specific to the shopping cart queue management.
tns1:OpenApp/WiseAI/ShoppingCartQueueMedium
<?xml version="1.0" encoding="UTF-8"?>
<ShoppingCartQueueMedium wstop:topic="true">
<tt:MessageDescription IsProperty="true">
<tt:Source>
<tt:SimpleItemDescription Name="VideoSourceToken" Type="tt:ReferenceToken"/>
<tt:SimpleItemDescription Name="RuleName" Type="xsd:string"/>
</tt:Source>
<tt:Data>
<tt:SimpleItemDescription Name="State" Type="xsd:boolean"/>
</tt:Data>
</tt:MessageDescription>
</ShoppingCartQueueMedium>
Channel.0.OpenSDK.WiseAI.ShoppingCartQueueMedium=True
Channel.0.OpenSDK.WiseAI.ShoppingCartQueueMedium.1=True
Channel.0.OpenSDK.WiseAI.ShoppingCartQueueMedium=True
Channel.0.OpenSDK.WiseAI.ShoppingCartQueueMedium.1.VideoSourceToken=VideoSourceToken-0
Channel.0.OpenSDK.WiseAI.ShoppingCartQueueMedium.1.RuleName=RuleName1
Channel.0.OpenSDK.WiseAI.ShoppingCartQueueMedium.1.State=True
{
"EventName": "OpenSDK.WiseAI.ShoppingCartQueueMedium",
"Time": "2022-03-15T02:58:52.820+00:00",
"Source": {
"Channel": 0,
"AppName": "WiseAI",
"AppID": "WiseAI",
"AppEvent": "ShoppingCartQueueMedium",
"Type": "Event",
"RuleIndex": 1,
"VideoSourceToken": "VideoSourceToken-0",
"RuleName": "rulename"
},
"Data": {
"State": true
}
}
tns1:OpenApp/WiseAI/ShoppingCartQueueHigh
<?xml version="1.0" encoding="UTF-8"?>
<ShoppingCartQueueHigh wstop:topic="true">
<tt:MessageDescription IsProperty="true">
<tt:Source>
<tt:SimpleItemDescription Name="VideoSourceToken" Type="tt:ReferenceToken"/>
<tt:SimpleItemDescription Name="RuleName" Type="xsd:string"/>
</tt:Source>
<tt:Data>
<tt:SimpleItemDescription Name="State" Type="xsd:boolean"/>
</tt:Data>
</tt:MessageDescription>
</ShoppingCartQueueHigh>
Channel.0.OpenSDK.WiseAI.ShoppingCartQueueHigh=True
Channel.0.OpenSDK.WiseAI.ShoppingCartQueueHigh.1=True
Channel.0.OpenSDK.WiseAI.ShoppingCartQueueHigh=True
Channel.0.OpenSDK.WiseAI.ShoppingCartQueueHigh.1.VideoSourceToken=VideoSourceToken-0
Channel.0.OpenSDK.WiseAI.ShoppingCartQueueHigh.1.RuleName=RuleName1
Channel.0.OpenSDK.WiseAI.ShoppingCartQueueHigh.1.State=True
{
"EventName": "OpenSDK.WiseAI.ShoppingCartQueueHigh",
"Time": "2022-03-15T02:58:52.820+00:00",
"Source": {
"Channel": 0,
"AppName": "WiseAI",
"AppID": "WiseAI",
"AppEvent": "ShoppingCartQueueHigh",
"Type": "Event",
"RuleIndex": 1,
"VideoSourceToken": "VideoSourceToken-0",
"RuleName": "rulename"
},
"Data": {
"State": true
}
}
The ShoppingCartQueueCountChanged event is generated only in JSON schema format, this event occurs only when the Count value is changed. "Count" data in ONVIF/SUNAPI event is counted over 1 second, not cumulative value. Also, if you want to know the counting result for a specific period, check the contents of "search/shoppingcartqueuemanagement"
tns1:OpenApp/WiseAI/ShoppingCartQueueCountChanged
<?xml version="1.0" encoding="UTF-8"?>
<ShoppingCartQueueCountChanged wstop:topic="true">
<tt:MessageDescription>
<tt:Source>
<tt:SimpleItemDescription Name="VideoSource" Type="tt:ReferenceToken"/>
<tt:SimpleItemDescription Name="RuleName" Type="xsd:string"/>
</tt:Source>
<tt:Data>
<tt:SimpleItemDescription Name="Count" Type="xsd:integer"/>
</tt:Data>
</tt:MessageDescription>
</ShoppingCartQueueCountChanged>
{
"EventName": "OpenSDK.WiseAI.ShoppingCartQueueCountChanged",
"Time": "2022-03-15T02:58:52.820+00:00",
"Source": {
"Channel": 0,
"AppName": "WiseAI",
"AppID": "WiseAI",
"AppEvent": "ShoppingCartQueueCountChanged",
"Type": "Event",
"RuleIndex": 1,
"VideoSourceToken": "VideoSourceToken-0",
"RuleName": "rulename"
},
"Data": {
"Count": 3
}
}
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "queuemanagementConfigurations": [
- {
- "channel": 0,
- "enable": true,
- "queues": [
- {
- "index": 1,
- "name": "string",
- "enable": true,
- "maxCount": 0,
- "queueAreaCoordinates": [
- {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}
], - "queueLevelHigh": {
- "count": 0,
- "enableEventNotification": true,
- "duration": 0
}, - "queueLevelMedium": {
- "count": 0,
- "enableEventNotification": true,
- "duration": 0
}
}
]
}
]
}Configures the shopping cart QueueManagement settings. For the supported values refer to shoppingcartqueuemanagement/options response.
| channel required | integer <int32> | ||||||||||||||||||||||||||||||||||||
| enable | boolean | ||||||||||||||||||||||||||||||||||||
Array of objects (QueueElement) | |||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||
{- "channel": 0,
- "enable": true,
- "queues": [
- {
- "index": 1,
- "name": "string",
- "enable": true,
- "maxCount": 0,
- "queueAreaCoordinates": [
- {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}
], - "queueLevelHigh": {
- "count": 0,
- "enableEventNotification": true,
- "duration": 0
}, - "queueLevelMedium": {
- "count": 0,
- "enableEventNotification": true,
- "duration": 0
}
}
]
}{- "response": "Success"
}Provides the supported values and ranges for the Shopping Cart QueueManagement configuration.
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "queuemanagementConfigurationOptions": [
- {
- "channel": 0,
- "queueOptions": {
- "index": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "queueAreaCoordinates": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "queueMaxCount": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "queueLevelHighOptions": {
- "count": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "duration": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}
}, - "queueLevelMediumOptions": {
- "count": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "duration": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}
}
}
}
]
}Delete an queue area based on requested queue index.
| channel required | integer <int32> Required channel parameter, operation is applicable only for the specified channel. |
| index required | Array of integers <int32> non-empty [ items <int32 > >= 1 ] Examples:
Required parameter, used to set a specific index. |
{- "response": "Success"
}Provides the reporting configuration of queuemanagement
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "reportingConfigurations": [
- {
- "channel": 0,
- "reportingRules": [
- {
- "index": 1,
- "reportEnable": true,
- "reportFileName": "string",
- "reportFileType": "string",
- "reportingSchedule": {
- "scheduleType": "string",
- "weekDay": "SUN",
- "hour": 23,
- "minute": 59
}
}
]
}
]
}Configures the Shopping Cart QueueManagement reporting configuration, for supported values refer to shoppingcartqueuemanagement/report/options response.
| channel required | integer <int32> | ||||||||||||||||||||
Array of objects (RuleReportingConfiguration) | |||||||||||||||||||||
Array
| |||||||||||||||||||||
{- "channel": 0,
- "reportingRules": [
- {
- "index": 1,
- "reportEnable": true,
- "reportFileName": "string",
- "reportFileType": "string",
- "reportingSchedule": {
- "scheduleType": "string",
- "weekDay": "SUN",
- "hour": 23,
- "minute": 59
}
}
]
}{- "response": "Success"
}Provides the supported values and ranges for the Shopping Cart QueueManagement reporting configuration.
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "reportingConfigurationOptions": [
- {
- "channel": 0,
- "ruleReportingOptions": {
- "index": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "reportFileTypes": [
- "string"
], - "reportingScheduleOptions": {
- "scheduleTypes": [
- "string"
], - "weekDays": [
- "string"
], - "hour": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "minute": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}
}
}
}
]
}Clears the Shopping Cart QueueManagement that is stored.
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "response": "Success"
}Initiate the shopping cart queuemanagement search based on search time duration and returns a search token
| channel required | integer <int32> Required channel parameter, operation is applicable only for the specified channel. |
| fromDate required | string <date-time> To filter results after the specified date time, example format 2021-07-28T04:40:16Z, if suffix Z not specified will be considered as local time. |
| toDate required | string <date-time> To filter results till the specified date time, example format 2021-07-28T04:40:16Z, if suffix Z not specified will be considered as local time. |
object (QueueSearchQueryObject) Advanced result filtering based on queue name |
{- "searchToken": "SearchToken-122212"
}Search token can be used to check if the search status is complete.
| searchToken required | string search token received after initiating search |
{- "status": "Completed"
}Client can cancel an intiated search session using this method. Should pass a valid search token to cancel.
| searchToken required | string search token received after initiating search |
{- "response": "Success"
}Once the search is complete, using the search token shopping cart queuemanagement results can be retreived.
| searchToken required | string search token received after initiating search |
{- "resultInterval": "Hourly",
- "queues": [
- {
- "index": 0,
- "averagePeopleResult": [
- 0
], - "queueLevelHigh": {
- "cumulativeTimeResult": [
- 0
]
}, - "queueLevelMedium": {
- "cumulativeTimeResult": [
- 0
]
}
}
]
}Getting the live queue count
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
| index | Array of integers <int32> non-empty [ items <int32 > >= 1 ] Examples:
Optional parameter, used to set a specific index. |
{- "queueCount": [
- {
- "channel": 0,
- "queues": [
- {
- "index": 0,
- "count": 0
}
]
}
]
}Get the Shopping Cart configuration, supported only if shoppingcartheatmap capability is set to true.
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "heatmapConfigurations": [
- {
- "channel": 0,
- "enable": true,
- "backgroundColorMode": "string",
- "enableManualReferenceMode": true,
- "autoReference": 0,
- "manualReference": 0,
- "excludeAreas": [
- {
- "index": 1,
- "name": "string",
- "areaCoordinates": [
- {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}
]
}
]
}
]
}Configures the Shopping Cart heatmap settings. For the supported values refer to shoppingcartheatmap/options response.
| channel required | integer <int32> | ||||||||||||
| enable | boolean | ||||||||||||
| backgroundColorMode | string | ||||||||||||
| enableManualReferenceMode | boolean | ||||||||||||
| manualReference | integer <int32> | ||||||||||||
Array of objects (ExcludeAreaElement) | |||||||||||||
Array
| |||||||||||||
{- "channel": 0,
- "enable": true,
- "backgroundColorMode": "string",
- "enableManualReferenceMode": true,
- "manualReference": 0,
- "excludeAreas": [
- {
- "index": 1,
- "name": "string",
- "areaCoordinates": [
- {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}
]
}
]
}{- "response": "Success"
}Provides the supported values and ranges for the Shopping Cart heatmap configuration.
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "heatmapConfigurationOptions": [
- {
- "channel": 0,
- "backgroundColorModes": [
- "string"
], - "manualReference": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "excludeAreaOptions": {
- "index": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "areaCoordinates": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}
}
}
]
}Delete the excludearea based on the requested exclude area index.
| channel required | integer <int32> Required channel parameter, operation is applicable only for the specified channel. |
| index required | Array of integers <int32> non-empty [ items <int32 > >= 1 ] Examples:
Required parameter, used to set a specific index. |
{- "response": "Success"
}Provides the reporting configuration of Shopping Cart heatmap
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "reportingConfigurations": [
- {
- "channel": 0,
- "reportingRules": [
- {
- "index": 1,
- "reportEnable": true,
- "reportFileName": "string",
- "reportFileType": "string",
- "reportingSchedule": {
- "scheduleType": "string",
- "weekDay": "SUN",
- "hour": 23,
- "minute": 59
}
}
]
}
]
}Configures the Shopping Cart heatmap reporting configuration, for supported values refer to shoppingcartheatmap/report/options response.
| channel required | integer <int32> | ||||||||||||||||||||
Array of objects (RuleReportingConfiguration) | |||||||||||||||||||||
Array
| |||||||||||||||||||||
{- "channel": 0,
- "reportingRules": [
- {
- "index": 1,
- "reportEnable": true,
- "reportFileName": "string",
- "reportFileType": "string",
- "reportingSchedule": {
- "scheduleType": "string",
- "weekDay": "SUN",
- "hour": 23,
- "minute": 59
}
}
]
}{- "response": "Success"
}Provides the supported values and ranges for the Shopping Cart heatmap reporting configuration.
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "reportingConfigurationOptions": [
- {
- "channel": 0,
- "ruleReportingOptions": {
- "index": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "reportFileTypes": [
- "string"
], - "reportingScheduleOptions": {
- "scheduleTypes": [
- "string"
], - "weekDays": [
- "string"
], - "hour": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "minute": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}
}
}
}
]
}Clears the Shopping Cart heatmap that is stored.
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "response": "Success"
}Initiate the shoppingcart heatmap search based on search time duration and returns a search token
| channel required | integer <int32> Required channel parameter, operation is applicable only for the specified channel. |
| fromDate required | string <date-time> To filter results after the specified date time, example format 2021-07-28T04:40:16Z, if suffix Z not specified will be considered as local time. |
| toDate required | string <date-time> To filter results till the specified date time, example format 2021-07-28T04:40:16Z, if suffix Z not specified will be considered as local time. |
| resultFormat | string Enum: "Image" "Json" Optional format parameter to get the search result in requested format. Default format is image. |
| resultImageType | string Enum: "WithBackground" "WithoutBackground" Example: resultImageType=WithBackground Optional result Image type selection, if not passed WithBackground will be selected. It's used when the resultFormat paramter is image |
{- "searchToken": "SearchToken-122212"
}Client can cancel an intiated search session using this method. Should pass a valid search token to cancel.
| searchToken required | string search token received after initiating search |
{- "response": "Success"
}Once the search is complete, using the search token shoppingcart heatmap image can be downloaded.
| searchToken required | string search token received after initiating search |
{- "response": "Fail",
- "error": {
- "code": 607,
- "details": "Unknown Error"
}
}Getting the live shoppingcart heatmap levels
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "heatmap": [
- {
- "channel": 0,
- "level": [
- 0
], - "resolution": {
- "width": 0,
- "height": 0
}, - "descriptor": 0
}
]
}Gets the vehicle queue qanagement configuration, suppport only if shoppingcartqueuemanagement capability is set to true. This configuration is specific to the vehicle queue management.
tns1:OpenApp/WiseAI/VehicleQueueMedium
<?xml version="1.0" encoding="UTF-8"?>
<VehicleQueueMedium wstop:topic="true">
<tt:MessageDescription IsProperty="true">
<tt:Source>
<tt:SimpleItemDescription Name="VideoSourceToken" Type="tt:ReferenceToken"/>
<tt:SimpleItemDescription Name="RuleName" Type="xsd:string"/>
</tt:Source>
<tt:Data>
<tt:SimpleItemDescription Name="State" Type="xsd:boolean"/>
</tt:Data>
</tt:MessageDescription>
</VehicleQueueMedium>
Channel.0.OpenSDK.WiseAI.VehicleQueueMedium=True
Channel.0.OpenSDK.WiseAI.VehicleQueueMedium.1=True
Channel.0.OpenSDK.WiseAI.VehicleQueueMedium=True
Channel.0.OpenSDK.WiseAI.VehicleQueueMedium.1.VideoSourceToken=VideoSourceToken-0
Channel.0.OpenSDK.WiseAI.VehicleQueueMedium.1.RuleName=RuleName1
Channel.0.OpenSDK.WiseAI.VehicleQueueMedium.1.State=True
{
"EventName": "OpenSDK.WiseAI.VehicleQueueMedium",
"Time": "2022-03-15T02:58:52.820+00:00",
"Source": {
"Channel": 0,
"AppName": "WiseAI",
"AppID": "WiseAI",
"AppEvent": "VehicleQueueMedium",
"Type": "Event",
"RuleIndex": 1,
"VideoSourceToken": "VideoSourceToken-0",
"RuleName": "rulename"
},
"Data": {
"State": true
}
}
tns1:OpenApp/WiseAI/VehicleQueueHigh
<?xml version="1.0" encoding="UTF-8"?>
<VehicleQueueHigh wstop:topic="true">
<tt:MessageDescription IsProperty="true">
<tt:Source>
<tt:SimpleItemDescription Name="VideoSourceToken" Type="tt:ReferenceToken"/>
<tt:SimpleItemDescription Name="RuleName" Type="xsd:string"/>
</tt:Source>
<tt:Data>
<tt:SimpleItemDescription Name="State" Type="xsd:boolean"/>
</tt:Data>
</tt:MessageDescription>
</VehicleQueueHigh>
Channel.0.OpenSDK.WiseAI.VehicleQueueHigh=True
Channel.0.OpenSDK.WiseAI.VehicleQueueHigh.1=True
Channel.0.OpenSDK.WiseAI.VehicleQueueHigh=True
Channel.0.OpenSDK.WiseAI.VehicleQueueHigh.1.VideoSourceToken=VideoSourceToken-0
Channel.0.OpenSDK.WiseAI.VehicleQueueHigh.1.RuleName=RuleName1
Channel.0.OpenSDK.WiseAI.VehicleQueueHigh.1.State=True
{
"EventName": "OpenSDK.WiseAI.VehicleQueueHigh",
"Time": "2022-03-15T02:58:52.820+00:00",
"Source": {
"Channel": 0,
"AppName": "WiseAI",
"AppID": "WiseAI",
"AppEvent": "VehicleQueueHigh",
"Type": "Event",
"RuleIndex": 1,
"VideoSourceToken": "VideoSourceToken-0",
"RuleName": "rulename"
},
"Data": {
"State": true
}
}
The VehicleQueueCountChanged event is generated only in JSON schema format, this event occurs only when the Count value is changed. "Count" data in ONVIF/SUNAPI event is counted over 1 second, not cumulative value. Also, if you want to know the counting result for a specific period, check the contents of "search/vehiclequeuemanagement"
tns1:OpenApp/WiseAI/VehicleQueueCountChanged
<?xml version="1.0" encoding="UTF-8"?>
<VehicleQueueCountChanged wstop:topic="true">
<tt:MessageDescription>
<tt:Source>
<tt:SimpleItemDescription Name="VideoSource" Type="tt:ReferenceToken"/>
<tt:SimpleItemDescription Name="RuleName" Type="xsd:string"/>
</tt:Source>
<tt:Data>
<tt:SimpleItemDescription Name="Count" Type="xsd:integer"/>
</tt:Data>
</tt:MessageDescription>
</VehicleQueueCountChanged>
{
"EventName": "OpenSDK.WiseAI.VehicleQueueCountChanged",
"Time": "2022-03-15T02:58:52.820+00:00",
"Source": {
"Channel": 0,
"AppName": "WiseAI",
"AppID": "WiseAI",
"AppEvent": "VehicleQueueCountChanged",
"Type": "Event",
"RuleIndex": 1,
"VideoSourceToken": "VideoSourceToken-0",
"RuleName": "rulename"
},
"Data": {
"Count": 3
}
}
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "queuemanagementConfigurations": [
- {
- "channel": 0,
- "enable": true,
- "queues": [
- {
- "index": 1,
- "name": "string",
- "enable": true,
- "maxCount": 0,
- "queueAreaCoordinates": [
- {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}
], - "queueLevelHigh": {
- "count": 0,
- "enableEventNotification": true,
- "duration": 0
}, - "queueLevelMedium": {
- "count": 0,
- "enableEventNotification": true,
- "duration": 0
}
}
]
}
]
}Configures the vehicle QueueManagement settings. For the supported values refer to vehiclequeuemanagement/options response.
| channel required | integer <int32> | ||||||||||||||||||||||||||||||||||||
| enable | boolean | ||||||||||||||||||||||||||||||||||||
Array of objects (QueueElement) | |||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||
{- "channel": 0,
- "enable": true,
- "queues": [
- {
- "index": 1,
- "name": "string",
- "enable": true,
- "maxCount": 0,
- "queueAreaCoordinates": [
- {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}
], - "queueLevelHigh": {
- "count": 0,
- "enableEventNotification": true,
- "duration": 0
}, - "queueLevelMedium": {
- "count": 0,
- "enableEventNotification": true,
- "duration": 0
}
}
]
}{- "response": "Success"
}Provides the supported values and ranges for the Vehicle QueueManagement configuration.
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "queuemanagementConfigurationOptions": [
- {
- "channel": 0,
- "queueOptions": {
- "index": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "queueAreaCoordinates": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "queueMaxCount": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "queueLevelHighOptions": {
- "count": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "duration": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}
}, - "queueLevelMediumOptions": {
- "count": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "duration": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}
}
}
}
]
}Delete an queue area based on requested queue index.
| channel required | integer <int32> Required channel parameter, operation is applicable only for the specified channel. |
| index required | Array of integers <int32> non-empty [ items <int32 > >= 1 ] Examples:
Required parameter, used to set a specific index. |
{- "response": "Success"
}Provides the reporting configuration of queuemanagement
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "reportingConfigurations": [
- {
- "channel": 0,
- "reportingRules": [
- {
- "index": 1,
- "reportEnable": true,
- "reportFileName": "string",
- "reportFileType": "string",
- "reportingSchedule": {
- "scheduleType": "string",
- "weekDay": "SUN",
- "hour": 23,
- "minute": 59
}
}
]
}
]
}Configures the Vehicle QueueManagement reporting configuration, for supported values refer to vehiclequeuemanagement/report/options response.
| channel required | integer <int32> | ||||||||||||||||||||
Array of objects (RuleReportingConfiguration) | |||||||||||||||||||||
Array
| |||||||||||||||||||||
{- "channel": 0,
- "reportingRules": [
- {
- "index": 1,
- "reportEnable": true,
- "reportFileName": "string",
- "reportFileType": "string",
- "reportingSchedule": {
- "scheduleType": "string",
- "weekDay": "SUN",
- "hour": 23,
- "minute": 59
}
}
]
}{- "response": "Success"
}Provides the supported values and ranges for the Vehicle QueueManagement reporting configuration.
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "reportingConfigurationOptions": [
- {
- "channel": 0,
- "ruleReportingOptions": {
- "index": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "reportFileTypes": [
- "string"
], - "reportingScheduleOptions": {
- "scheduleTypes": [
- "string"
], - "weekDays": [
- "string"
], - "hour": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "minute": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}
}
}
}
]
}Clears the Vehicle QueueManagement that is stored.
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "response": "Success"
}Initiate the vehicle queuemanagement search based on search time duration and returns a search token
| channel required | integer <int32> Required channel parameter, operation is applicable only for the specified channel. |
| fromDate required | string <date-time> To filter results after the specified date time, example format 2021-07-28T04:40:16Z, if suffix Z not specified will be considered as local time. |
| toDate required | string <date-time> To filter results till the specified date time, example format 2021-07-28T04:40:16Z, if suffix Z not specified will be considered as local time. |
object (QueueSearchQueryObject) Advanced result filtering based on queue name |
{- "searchToken": "SearchToken-122212"
}Search token can be used to check if the search status is complete.
| searchToken required | string search token received after initiating search |
{- "status": "Completed"
}Client can cancel an intiated search session using this method. Should pass a valid search token to cancel.
| searchToken required | string search token received after initiating search |
{- "response": "Success"
}Once the search is complete, using the search token vehicle queuemanagement results can be retreived.
| searchToken required | string search token received after initiating search |
{- "resultInterval": "Hourly",
- "queues": [
- {
- "index": 0,
- "averagePeopleResult": [
- 0
], - "queueLevelHigh": {
- "cumulativeTimeResult": [
- 0
]
}, - "queueLevelMedium": {
- "cumulativeTimeResult": [
- 0
]
}
}
]
}Getting the live queue count
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
| index | Array of integers <int32> non-empty [ items <int32 > >= 1 ] Examples:
Optional parameter, used to set a specific index. |
{- "queueCount": [
- {
- "channel": 0,
- "queues": [
- {
- "index": 0,
- "count": 0
}
]
}
]
}Get the Vehicle configuration, supported only if vehicleheatmap capability is set to true.
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "heatmapConfigurations": [
- {
- "channel": 0,
- "enable": true,
- "backgroundColorMode": "string",
- "enableManualReferenceMode": true,
- "autoReference": 0,
- "manualReference": 0,
- "excludeAreas": [
- {
- "index": 1,
- "name": "string",
- "areaCoordinates": [
- {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}
]
}
]
}
]
}Configures the Vehicle heatmap settings. For the supported values refer to vehicleheatmap/options response.
| channel required | integer <int32> | ||||||||||||
| enable | boolean | ||||||||||||
| backgroundColorMode | string | ||||||||||||
| enableManualReferenceMode | boolean | ||||||||||||
| manualReference | integer <int32> | ||||||||||||
Array of objects (ExcludeAreaElement) | |||||||||||||
Array
| |||||||||||||
{- "channel": 0,
- "enable": true,
- "backgroundColorMode": "string",
- "enableManualReferenceMode": true,
- "manualReference": 0,
- "excludeAreas": [
- {
- "index": 1,
- "name": "string",
- "areaCoordinates": [
- {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}
]
}
]
}{- "response": "Success"
}Provides the supported values and ranges for the Vehicle heatmap configuration.
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "heatmapConfigurationOptions": [
- {
- "channel": 0,
- "backgroundColorModes": [
- "string"
], - "manualReference": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "excludeAreaOptions": {
- "index": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "areaCoordinates": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}
}
}
]
}Delete the excludearea based on the requested exclude area index.
| channel required | integer <int32> Required channel parameter, operation is applicable only for the specified channel. |
| index required | Array of integers <int32> non-empty [ items <int32 > >= 1 ] Examples:
Required parameter, used to set a specific index. |
{- "response": "Success"
}Provides the reporting configuration of Vehicle heatmap
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "reportingConfigurations": [
- {
- "channel": 0,
- "reportingRules": [
- {
- "index": 1,
- "reportEnable": true,
- "reportFileName": "string",
- "reportFileType": "string",
- "reportingSchedule": {
- "scheduleType": "string",
- "weekDay": "SUN",
- "hour": 23,
- "minute": 59
}
}
]
}
]
}Configures the Vehicle heatmap reporting configuration, for supported values refer to vehicleheatmap/report/options response.
| channel required | integer <int32> | ||||||||||||||||||||
Array of objects (RuleReportingConfiguration) | |||||||||||||||||||||
Array
| |||||||||||||||||||||
{- "channel": 0,
- "reportingRules": [
- {
- "index": 1,
- "reportEnable": true,
- "reportFileName": "string",
- "reportFileType": "string",
- "reportingSchedule": {
- "scheduleType": "string",
- "weekDay": "SUN",
- "hour": 23,
- "minute": 59
}
}
]
}{- "response": "Success"
}Provides the supported values and ranges for the Vehicle heatmap reporting configuration.
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "reportingConfigurationOptions": [
- {
- "channel": 0,
- "ruleReportingOptions": {
- "index": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "reportFileTypes": [
- "string"
], - "reportingScheduleOptions": {
- "scheduleTypes": [
- "string"
], - "weekDays": [
- "string"
], - "hour": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "minute": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}
}
}
}
]
}Clears the Vehicle heatmap that is stored.
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "response": "Success"
}Initiate the vehicle heatmap search based on search time duration and returns a search token
| channel required | integer <int32> Required channel parameter, operation is applicable only for the specified channel. |
| fromDate required | string <date-time> To filter results after the specified date time, example format 2021-07-28T04:40:16Z, if suffix Z not specified will be considered as local time. |
| toDate required | string <date-time> To filter results till the specified date time, example format 2021-07-28T04:40:16Z, if suffix Z not specified will be considered as local time. |
| resultFormat | string Enum: "Image" "Json" Optional format parameter to get the search result in requested format. Default format is image. |
| resultImageType | string Enum: "WithBackground" "WithoutBackground" Example: resultImageType=WithBackground Optional result Image type selection, if not passed WithBackground will be selected. It's used when the resultFormat paramter is image |
{- "searchToken": "SearchToken-122212"
}Client can cancel an intiated search session using this method. Should pass a valid search token to cancel.
| searchToken required | string search token received after initiating search |
{- "response": "Success"
}Once the search is complete, using the search token vehicle heatmap image can be downloaded.
| searchToken required | string search token received after initiating search |
{- "response": "Fail",
- "error": {
- "code": 607,
- "details": "Unknown Error"
}
}Getting the live vehicle heatmap levels
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "heatmap": [
- {
- "channel": 0,
- "level": [
- 0
], - "resolution": {
- "width": 0,
- "height": 0
}, - "descriptor": 0
}
]
}line based vehicle speed detection configurations, a device that indicates capability of vehiclespeeddetection in getcapability command shall support this command. When vehicle speed detection is enabled, event is delivered in below formats,
tns1:OpenApp/WiseAI/VehicleSpeedDetection
<?xml version="1.0" encoding="UTF-8"?>
<VehicleSpeedDetection wstop:topic="true">
<tt:MessageDescription>
<tt:Source>
<tt:SimpleItemDescription Name="VideoSourceToken" Type="tt:ReferenceToken"/>
<tt:SimpleItemDescription Name="RuleName" Type="xsd:string"/>
</tt:Source>
<tt:Data>
<tt:SimpleItemDescription Name="Speed" Type="xsd:float"/>
<tt:SimpleItemDescription Name="ObjectId" Type="xsd:integer"/>
<tt:SimpleItemDescription Name="State" Type="xsd:boolean"/>
</tt:Data>
</tt:MessageDescription>
</VehicleSpeedDetection>
Channel.0.OpenSDK.WiseAI.VehicleSpeedDetection=True
Channel.0.OpenSDK.WiseAI.VehicleSpeedDetection.1=True
Channel.0.OpenSDK.WiseAI.VehicleSpeedDetection=True
Channel.0.OpenSDK.WiseAI.VehicleSpeedDetection.1.VideoSourceToken=VideoSourceToken-0
Channel.0.OpenSDK.WiseAI.VehicleSpeedDetection.1.RuleName=rulename
Channel.0.OpenSDK.WiseAI.VehicleSpeedDetection.1.Speed=3.5
Channel.0.OpenSDK.WiseAI.VehicleSpeedDetection.1.ObjectId=1234
Channel.0.OpenSDK.WiseAI.VehicleSpeedDetection.1.State=True
{
"EventName": "OpenSDK.WiseAI.VehicleSpeedDetection",
"Time": "2021-10-27T07:36:14.509+00:00",
"Source": {
"Channel": 0,
"AppName": "WiseAI",
"AppID": "WiseAI",
"AppEvent": "VehicleSpeedDetection",
"Type": "Event",
"RuleIndex": 1,
"VideoSourceToken": "VideoSourceToken-0",
"RuleName": "rulename"
},
"Data": {
"Speed": 3.5,
"ObjectId": 1234,
"State": true
}
}
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "configurations": [
- {
- "channel": 0,
- "enable": true,
- "distanceSpeedUnit": "string",
- "detectionRules": [
- {
- "index": 1,
- "name": "string",
- "objectTypes": [
- "string"
], - "lines": [
- {
- "lineCoordinates": [
- {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}
]
}
], - "areaCoordinates": [
- {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}
], - "distance": 0.1,
- "speed": 0
}
]
}
]
}line based vehicle speed detection configurations, a device that indicates capability of vehiclespeeddetection in getcapability command shall support this command.
| channel required | integer <int32> | ||||||||||||||||||||||||
| enable | boolean | ||||||||||||||||||||||||
| distanceSpeedUnit | string | ||||||||||||||||||||||||
Array of objects (VehicleSpeedDetectionRule) | |||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||
{- "channel": 0,
- "enable": true,
- "distanceSpeedUnit": "string",
- "detectionRules": [
- {
- "index": 1,
- "name": "string",
- "objectTypes": [
- "string"
], - "lines": [
- {
- "lineCoordinates": [
- {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}
]
}
], - "areaCoordinates": [
- {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}
], - "distance": 0.1,
- "speed": 0
}
]
}{- "response": "Success"
}Provide allowed values of each parameters in vehicle speed detection configuration. Ranges of parameters in vehicle speed detection configuration, a device that indicates capability of vehiclespeeddetection in getcapability command shall support this command.
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "options": [
- {
- "channel": 0,
- "distanceSpeedUnit": [
- "string"
], - "detectionRules": {
- "index": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "objectTypes": [
- "string"
], - "lineCount": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "lineCoordinates": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "areaCoordinates": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "kph": {
- "distance": {
- "min": 0.1,
- "max": 0.1,
- "step": 0.1,
- "default": 0.1
}, - "speed": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}
}, - "mph": {
- "distance": {
- "min": 0.1,
- "max": 0.1,
- "step": 0.1,
- "default": 0.1
}, - "speed": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}
}
}
}
]
}Delete the rule for the requested index.
| channel required | integer <int32> Required channel parameter, operation is applicable only for the specified channel. |
| index required | Array of integers <int32> non-empty [ items <int32 > >= 1 ] Examples:
Required parameter, used to set a specific index. |
{- "response": "Success"
}gets the pedestrian detection settings that is configured. Can check if pedestriandetection feature is supported from the configuration/capability response.
tns1:OpenApp/WiseAI/PedestrianDetection
<?xml version="1.0" encoding="UTF-8"?>
<PedestrianDetection wstop:topic="true">
<tt:MessageDescription>
<tt:Source>
<tt:SimpleItemDescription Name="VideoSourceToken" Type="tt:ReferenceToken"/>
<tt:SimpleItemDescription Name="RuleName" Type="xsd:string"/>
</tt:Source>
<tt:Data>
<tt:SimpleItemDescription Name="State" Type="xsd:boolean"/>
<tt:SimpleItemDescription Name="ObjectId" Type="tt:StringList"/>
</tt:Data>
</tt:MessageDescription>
</PedestrianDetection>
Channel.0.OpenSDK.WiseAI.PedestrianDetection=True
Channel.0.OpenSDK.WiseAI.PedestrianDetection.1=True
Channel.0.OpenSDK.WiseAI.PedestrianDetection=True
Channel.0.OpenSDK.WiseAI.PedestrianDetection.1.VideoSourceToken=VideoSourceToken-0
Channel.0.OpenSDK.WiseAI.PedestrianDetection.1.RuleName=RuleName1
Channel.0.OpenSDK.WiseAI.PedestrianDetection.1.State=True
Channel.0.OpenSDK.WiseAI.PedestrianDetection.1.ObjectId=1 2
{
"EventName": "OpenSDK.WiseAI.PedestrianDetection",
"Time": "2022-03-15T02:58:52.820+00:00",
"Source": {
"Channel": 0,
"AppName": "WiseAI",
"AppID": "WiseAI",
"AppEvent": "PedestrianDetection",
"Type": "Event",
"RuleIndex": 1,
"VideoSourceToken": "VideoSourceToken-0",
"RuleName": "rulename"
},
"Data": {
"State": true,
"ObjectId": "1 2"
}
}
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "pedestrianDetection": [
- {
- "channel": 0,
- "enable": true,
- "detectionAreas": [
- {
- "index": 1,
- "name": "string",
- "duration": 0,
- "areaCoordinates": [
- {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}
], - "objectTypes": [
- "string"
]
}
]
}
]
}Configures the pedestrian detection settings, for supported values and ranges refer to pedestrianDetection/options response.
| channel | integer <int32> | ||||||||||||||||
| enable | boolean | ||||||||||||||||
Array of objects (PedestrianDetectionAreaElement) | |||||||||||||||||
Array
| |||||||||||||||||
{- "channel": 0,
- "enable": true,
- "detectionAreas": [
- {
- "index": 1,
- "name": "string",
- "duration": 0,
- "areaCoordinates": [
- {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}
], - "objectTypes": [
- "string"
]
}
]
}{- "response": "Success"
}Delete the area for the requested index.
| channel required | integer <int32> Required channel parameter, operation is applicable only for the specified channel. |
| index required | Array of integers <int32> non-empty [ items <int32 > >= 1 ] Examples:
Required parameter, used to set a specific index. |
{- "response": "Success"
}Supported values and ranges reguired for configuring pedestrian detection is provided in response.
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "pedestrianDetectionOptions": [
- {
- "channel": 0,
- "detectionAreaOptions": {
- "index": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "duration": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "areaCoordinates": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "objectTypes": [
- "string"
]
}
}
]
}line based wrong-way detection configurations, a device that indicates capability of wrongwaydetection in getcapability command shall support this command. When Wrong-way detection is enabled, event is delivered in below formats,
tns1:OpenApp/WiseAI/WrongwayDetection
<?xml version="1.0" encoding="UTF-8"?>
<WrongwayDetection wstop:topic="true">
<tt:MessageDescription>
<tt:Source>
<tt:SimpleItemDescription Name="VideoSourceToken" Type="tt:ReferenceToken"/>
<tt:SimpleItemDescription Name="RuleName" Type="xsd:string"/>
</tt:Source>
<tt:Data>
<tt:SimpleItemDescription Name="State" Type="xsd:boolean"/>
<tt:SimpleItemDescription Name="ObjectId" Type="tt:StringList"/>
</tt:Data>
</tt:MessageDescription>
</WrongwayDetection>
Channel.0.OpenSDK.WiseAI.WrongwayDetection=True
Channel.0.OpenSDK.WiseAI.WrongwayDetection.1=True
Channel.0.OpenSDK.WiseAI.WrongwayDetection=True
Channel.0.OpenSDK.WiseAI.WrongwayDetection.1.VideoSourceToken=VideoSourceToken-0
Channel.0.OpenSDK.WiseAI.WrongwayDetection.1.RuleName=rulename
Channel.0.OpenSDK.WiseAI.WrongwayDetection.1.State=True
Channel.0.OpenSDK.WiseAI.WrongwayDetection.1.ObjectId=1
{
"EventName": "OpenSDK.WiseAI.WrongwayDetection",
"Time": "2021-10-27T07:36:14.509+00:00",
"Source": {
"Channel": 0,
"AppName": "WiseAI",
"AppID": "WiseAI",
"AppEvent": "WrongwayDetection",
"Type": "Event",
"RuleIndex": 1,
"VideoSourceToken": "VideoSourceToken-0",
"RuleName": "rulename"
},
"Data": {
"State": true,
"ObjectId": 1
}
}
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "wrongwayDetectionConfiguration": [
- {
- "channel": 0,
- "enable": true,
- "detectionRules": [
- {
- "index": 1,
- "name": "string",
- "objectTypes": [
- "string"
], - "lines": [
- {
- "lineCoordinates": [
- {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}
]
}
], - "pathPoints": [
- {
- "x": 0,
- "y": 0
}
]
}
]
}
]
}line based wrong-way detection configurations, a device that indicates capability of wrongwaydetection in getcapability command shall support this command.
| channel required | integer <int32> | ||||||||||||||||||||
| enable | boolean | ||||||||||||||||||||
Array of objects (WrongwayDetectionRule) | |||||||||||||||||||||
Array
| |||||||||||||||||||||
{- "channel": 0,
- "enable": true,
- "detectionRules": [
- {
- "index": 1,
- "name": "string",
- "objectTypes": [
- "string"
], - "lines": [
- {
- "lineCoordinates": [
- {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}
]
}
], - "pathPoints": [
- {
- "x": 0,
- "y": 0
}
]
}
]
}{- "response": "Success"
}Provide allowed values of each parameters in wrong-way detection configuration. Ranges of parameters in wrong-way detection configuration, a device that indicates capability of wrongwaydetection in getcapability command shall support this command.
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "wrongwayDetectionOptions": [
- {
- "channel": 0,
- "detectionRules": {
- "index": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "objectTypes": [
- "string"
], - "lineCount": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "lineCoordinates": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "pathPoints": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}
}
}
]
}Delete the rule for the requested index.
| channel required | integer <int32> Required channel parameter, operation is applicable only for the specified channel. |
| index required | Array of integers <int32> non-empty [ items <int32 > >= 1 ] Examples:
Required parameter, used to set a specific index. |
{- "response": "Success"
}Generic Multi-lane vehicle counting configuration, that can be used for counting objects that crosses the configured lines. For supported objecttypes you can refer to multilanevehiclecounting/options command response.
The MultiLaneVehicleCounting event is generated only in JSON schema format, this event occurs only when the Count value is changed.
Currently only "Punctual" ReportType is supported, but it may be extended to other ReportTypes such as "Summary" in the future.
"Count" data in ONVIF/SUNAPI event is counted over 1 second, not cumulative value.
Also, if you want to know the counting result for a specific period, check the contents of "search/multilanevehiclecounting"
tns1:OpenApp/WiseAI/MultiLaneVehicleCounting
<?xml version="1.0" encoding="UTF-8"?>
<MultiLaneVehicleCounting wstop:topic="true">
<tt:MessageDescription>
<tt:Source>
<tt:SimpleItemDescription Name="VideoSource" Type="tt:ReferenceToken"/>
<tt:SimpleItemDescription Name="RuleName" Type="xsd:string"/>
</tt:Source>
<tt:Data>
<tt:SimpleItemDescription Name="ReportType" Type="xsd:string"/>
<tt:SimpleItemDescription Name="ObjectType" Type="xsd:string"/>
<tt:SimpleItemDescription Name="Direction" Type="xsd:string"/>
<tt:SimpleItemDescription Name="Count" Type="xsd:integer"/>
</tt:Data>
</tt:MessageDescription>
</MultiLaneVehicleCounting>
{
"EventName": "OpenSDK.WiseAI.MultiLaneVehicleCounting",
"Time": "2022-03-15T02:58:52.820+00:00",
"Source": {
"Channel": 0,
"AppName": "WiseAI",
"AppID": "WiseAI",
"AppEvent": "MultiLaneVehicleCounting",
"Type": "Event",
"RuleIndex": 1,
"VideoSourceToken": "VideoSourceToken-0",
"RuleName": "rulename"
},
"Data": {
"ReportType": "Punctual",
"ObjectType": "Vehicle",
"Direction": "IN",
"Count": 3
}
}
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "configurations": [
- {
- "channel": 0,
- "enable": true,
- "countingRules": [
- {
- "index": 1,
- "name": "string",
- "objectTypes": [
- "string"
], - "lines": [
- {
- "lineCoordinates": [
- {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}
]
}
], - "pathPoints": [
- {
- "x": 0,
- "y": 0
}
]
}
], - "excludeAreas": [
- {
- "index": 1,
- "name": "string",
- "areaCoordinates": [
- {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}
]
}
]
}
]
}Configurest the generic multilanevehiclecounting rule, can be used to count objectypes provided in the multilanevehiclecounting/options.
| channel required | integer <int32> | ||||||||||||||||||||
| enable | boolean | ||||||||||||||||||||
Array of objects (MultiLaneVehicleCountingRule) | |||||||||||||||||||||
Array
| |||||||||||||||||||||
Array of objects (ExcludeAreaElement) | |||||||||||||||||||||
Array
| |||||||||||||||||||||
{- "channel": 0,
- "enable": true,
- "countingRules": [
- {
- "index": 1,
- "name": "string",
- "objectTypes": [
- "string"
], - "lines": [
- {
- "lineCoordinates": [
- {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}
]
}
], - "pathPoints": [
- {
- "x": 0,
- "y": 0
}
]
}
], - "excludeAreas": [
- {
- "index": 1,
- "name": "string",
- "areaCoordinates": [
- {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}
]
}
]
}{- "response": "Success"
}Provides the values supported in multilanevehiclecounting rule
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "configurationOptions": [
- {
- "channel": 0,
- "excludeAreaOptions": {
- "index": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "areaCoordinates": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}
}, - "countingRuleOptions": {
- "index": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "objectTypes": [
- "string"
], - "lineCount": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "lineCoordinates": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "pathPoints": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}
}
}
]
}Delete the rule based on requested counting counting rule index.
| channel required | integer <int32> Required channel parameter, operation is applicable only for the specified channel. |
| index required | Array of integers <int32> [ items <int32 > >= 1 ] counting rule index in which the line has to be deleted |
{- "response": "Success"
}Delete the excludearea based on the requested exclude area index.
| channel required | integer <int32> Required channel parameter, operation is applicable only for the specified channel. |
| index required | Array of integers <int32> [ items <int32 > >= 1 ] The exclude areas can be deleted |
{- "response": "Success"
}Provides the reporting configuration of ObjectingCounting
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "reportingConfigurations": [
- {
- "channel": 0,
- "reportingRules": [
- {
- "index": 1,
- "reportEnable": true,
- "reportFileName": "string",
- "reportFileType": "string",
- "reportingSchedule": {
- "scheduleType": "string",
- "weekDay": "SUN",
- "hour": 23,
- "minute": 59
}
}
]
}
]
}Configures the MultiLaneVehicleCounting reporting configuration, for supported values refer to multilanevehiclecounting/report/options response.
| channel required | integer <int32> | ||||||||||||||||||||
Array of objects (RuleReportingConfiguration) | |||||||||||||||||||||
Array
| |||||||||||||||||||||
{- "channel": 0,
- "reportingRules": [
- {
- "index": 1,
- "reportEnable": true,
- "reportFileName": "string",
- "reportFileType": "string",
- "reportingSchedule": {
- "scheduleType": "string",
- "weekDay": "SUN",
- "hour": 23,
- "minute": 59
}
}
]
}{- "response": "Success"
}Provides the supported values and ranges for the multilanevehiclecounting reporting configuration.
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "reportingConfigurationOptions": [
- {
- "channel": 0,
- "ruleReportingOptions": {
- "index": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "reportFileTypes": [
- "string"
], - "reportingScheduleOptions": {
- "scheduleTypes": [
- "string"
], - "weekDays": [
- "string"
], - "hour": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "minute": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}
}
}
}
]
}Clears the counting data that is stored.
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "response": "Success"
}Initiate the multilanevehiclecounting search based on search time duration and returns a search token
| channel required | integer <int32> Required channel parameter, operation is applicable only for the specified channel. |
| fromDate required | string <date-time> To filter results after the specified date time, example format 2021-07-28T04:40:16Z, if suffix Z not specified will be considered as local time. |
| toDate required | string <date-time> To filter results till the specified date time, example format 2021-07-28T04:40:16Z, if suffix Z not specified will be considered as local time. |
{- "searchToken": "SearchToken-122212"
}Search token can be used to check if the search status is complete.
| searchToken required | string search token received after initiating search |
{- "status": "Completed"
}Client can cancel an intiated search session using this method. Should pass a valid search token to cancel.
| searchToken required | string search token received after initiating search |
{- "response": "Success"
}Once the search is complete, using the search token multilanevehiclecounting results can be retreived. In directionBasedResult json array reseponse, there is direction. As of not only "IN" is supported. For the "OUT" in the future.
| searchToken required | string search token received after initiating search |
| includeAIData | boolean Optional field to request AI data in the result |
{- "resultInterval": "Hourly",
- "countingRules": [
- {
- "index": 1,
- "directionBasedResult": [
- {
- "direction": "IN",
- "result": [
- 0
], - "objectTypesResult": [
- {
- "objectType": "string",
- "result": [
- 0
]
}
]
}
]
}
]
}Getting the live multilanevehicle counting data In directionBasedResult json array reseponse, there is direction. As of not only "IN" is supported. For the "OUT" in the future.
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
| index | integer <int32> >= 1 Optional counting rule index to get the result for the specified counting rule. If index is not specified, show all. |
| includeAIData | boolean Optional field to request AI data in the result |
{- "countingLive": [
- {
- "channel": 0,
- "countingRules": [
- {
- "index": 1,
- "directionBasedResult": [
- {
- "direction": "IN",
- "count": 0,
- "objectTypesResult": [
- {
- "objectType": "string",
- "count": 0
}
]
}
]
}
]
}
]
}Get the commercial vehicle detection configurations. The commercial vehicle detection configurations, a device that indicates capability of commercialvehicledetection in getcapability command shall support this command.
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "configurations": [
- {
- "channel": 0,
- "enable": true,
- "lines": [
- {
- "index": 1,
- "name": "string",
- "mode": "LeftToRightIn",
- "lineCoordinates": [
- {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}
], - "objectTypes": [
- "string"
]
}
]
}
]
}Update or enable the commercial vehicle detection configuration. a device that indicates capability of commercialvehicledetection in getcapability command shall support this command.
| channel required | integer <int32> | ||||||||||||||||
| enable | boolean | ||||||||||||||||
Array of objects (CommercialVehicleDetectionLineElement) | |||||||||||||||||
Array
| |||||||||||||||||
{- "channel": 0,
- "enable": true,
- "lines": [
- {
- "index": 1,
- "name": "string",
- "mode": "LeftToRightIn",
- "lineCoordinates": [
- {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}
], - "objectTypes": [
- "string"
]
}
]
}{- "response": "Success"
}Provide allowed values of each parameters in the commercial vehicle detection configuration. Ranges of parameters in the commercial vehicle detection configuration, a device that indicates capability of commercialvehicledetection in getcapability command shall support this command.
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "options": [
- {
- "channel": 0,
- "lineOptions": {
- "index": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "lineCoordinates": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "objectTypes": [
- "string"
]
}
}
]
}Delete the lines based on requested index.
| channel required | integer <int32> Required channel parameter, operation is applicable only for the specified channel. |
| index required | Array of integers <int32> non-empty [ items <int32 > >= 1 ] Examples:
Required parameter, used to set a specific index. |
{- "response": "Success"
}Gets the forklift queue qanagement configuration, suppport only if forkliftqueuemanagement capability is set to true. This configuration is specific to the forklift queue management.
tns1:OpenApp/WiseAI/ForkliftQueueMedium
<?xml version="1.0" encoding="UTF-8"?>
<ForkliftQueueMedium wstop:topic="true">
<tt:MessageDescription IsProperty="true">
<tt:Source>
<tt:SimpleItemDescription Name="VideoSourceToken" Type="tt:ReferenceToken"/>
<tt:SimpleItemDescription Name="RuleName" Type="xsd:string"/>
</tt:Source>
<tt:Data>
<tt:SimpleItemDescription Name="State" Type="xsd:boolean"/>
</tt:Data>
</tt:MessageDescription>
</ForkliftQueueMedium>
Channel.0.OpenSDK.WiseAI.ForkliftQueueMedium=True
Channel.0.OpenSDK.WiseAI.ForkliftQueueMedium.1=True
Channel.0.OpenSDK.WiseAI.ForkliftQueueMedium=True
Channel.0.OpenSDK.WiseAI.ForkliftQueueMedium.1.VideoSourceToken=VideoSourceToken-0
Channel.0.OpenSDK.WiseAI.ForkliftQueueMedium.1.RuleName=RuleName1
Channel.0.OpenSDK.WiseAI.ForkliftQueueMedium.1.State=True
{
"EventName": "OpenSDK.WiseAI.ForkliftQueueMedium",
"Time": "2022-03-15T02:58:52.820+00:00",
"Source": {
"Channel": 0,
"AppName": "WiseAI",
"AppID": "WiseAI",
"AppEvent": "ForkliftQueueMedium",
"Type": "Event",
"RuleIndex": 1,
"VideoSourceToken": "VideoSourceToken-0",
"RuleName": "rulename"
},
"Data": {
"State": true
}
}
tns1:OpenApp/WiseAI/ForkliftQueueHigh
<?xml version="1.0" encoding="UTF-8"?>
<ForkliftQueueHigh wstop:topic="true">
<tt:MessageDescription IsProperty="true">
<tt:Source>
<tt:SimpleItemDescription Name="VideoSourceToken" Type="tt:ReferenceToken"/>
<tt:SimpleItemDescription Name="RuleName" Type="xsd:string"/>
</tt:Source>
<tt:Data>
<tt:SimpleItemDescription Name="State" Type="xsd:boolean"/>
</tt:Data>
</tt:MessageDescription>
</ForkliftQueueHigh>
Channel.0.OpenSDK.WiseAI.ForkliftQueueHigh=True
Channel.0.OpenSDK.WiseAI.ForkliftQueueHigh.1=True
Channel.0.OpenSDK.WiseAI.ForkliftQueueHigh=True
Channel.0.OpenSDK.WiseAI.ForkliftQueueHigh.1.VideoSourceToken=VideoSourceToken-0
Channel.0.OpenSDK.WiseAI.ForkliftQueueHigh.1.RuleName=RuleName1
Channel.0.OpenSDK.WiseAI.ForkliftQueueHigh.1.State=True
{
"EventName": "OpenSDK.WiseAI.ForkliftQueueHigh",
"Time": "2022-03-15T02:58:52.820+00:00",
"Source": {
"Channel": 0,
"AppName": "WiseAI",
"AppID": "WiseAI",
"AppEvent": "ForkliftQueueHigh",
"Type": "Event",
"RuleIndex": 1,
"VideoSourceToken": "VideoSourceToken-0",
"RuleName": "rulename"
},
"Data": {
"State": true
}
}
The ForkliftQueueCountChanged event is generated only in JSON schema format, this event occurs only when the Count value is changed. "Count" data in ONVIF/SUNAPI event is counted over 1 second, not cumulative value. Also, if you want to know the counting result for a specific period, check the contents of "search/forkliftqueuemanagement"
tns1:OpenApp/WiseAI/ForkliftQueueCountChanged
<?xml version="1.0" encoding="UTF-8"?>
<ForkliftQueueCountChanged wstop:topic="true">
<tt:MessageDescription>
<tt:Source>
<tt:SimpleItemDescription Name="VideoSource" Type="tt:ReferenceToken"/>
<tt:SimpleItemDescription Name="RuleName" Type="xsd:string"/>
</tt:Source>
<tt:Data>
<tt:SimpleItemDescription Name="Count" Type="xsd:integer"/>
</tt:Data>
</tt:MessageDescription>
</ForkliftQueueCountChanged>
{
"EventName": "OpenSDK.WiseAI.ForkliftQueueCountChanged",
"Time": "2022-03-15T02:58:52.820+00:00",
"Source": {
"Channel": 0,
"AppName": "WiseAI",
"AppID": "WiseAI",
"AppEvent": "ForkliftQueueCountChanged",
"Type": "Event",
"RuleIndex": 1,
"VideoSourceToken": "VideoSourceToken-0",
"RuleName": "rulename"
},
"Data": {
"Count": 3
}
}
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "queuemanagementConfigurations": [
- {
- "channel": 0,
- "enable": true,
- "queues": [
- {
- "index": 1,
- "name": "string",
- "enable": true,
- "maxCount": 0,
- "queueAreaCoordinates": [
- {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}
], - "queueLevelHigh": {
- "count": 0,
- "enableEventNotification": true,
- "duration": 0
}, - "queueLevelMedium": {
- "count": 0,
- "enableEventNotification": true,
- "duration": 0
}
}
]
}
]
}Configures the forklift QueueManagement settings. For the supported values refer to forkliftqueuemanagement/options response.
| channel required | integer <int32> | ||||||||||||||||||||||||||||||||||||
| enable | boolean | ||||||||||||||||||||||||||||||||||||
Array of objects (QueueElement) | |||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||
{- "channel": 0,
- "enable": true,
- "queues": [
- {
- "index": 1,
- "name": "string",
- "enable": true,
- "maxCount": 0,
- "queueAreaCoordinates": [
- {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}
], - "queueLevelHigh": {
- "count": 0,
- "enableEventNotification": true,
- "duration": 0
}, - "queueLevelMedium": {
- "count": 0,
- "enableEventNotification": true,
- "duration": 0
}
}
]
}{- "response": "Success"
}Provides the supported values and ranges for the Forklift QueueManagement configuration.
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "queuemanagementConfigurationOptions": [
- {
- "channel": 0,
- "queueOptions": {
- "index": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "queueAreaCoordinates": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "queueMaxCount": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "queueLevelHighOptions": {
- "count": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "duration": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}
}, - "queueLevelMediumOptions": {
- "count": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "duration": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}
}
}
}
]
}Delete an queue area based on requested queue index.
| channel required | integer <int32> Required channel parameter, operation is applicable only for the specified channel. |
| index required | Array of integers <int32> non-empty [ items <int32 > >= 1 ] Examples:
Required parameter, used to set a specific index. |
{- "response": "Success"
}Provides the reporting configuration of queuemanagement
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "reportingConfigurations": [
- {
- "channel": 0,
- "reportingRules": [
- {
- "index": 1,
- "reportEnable": true,
- "reportFileName": "string",
- "reportFileType": "string",
- "reportingSchedule": {
- "scheduleType": "string",
- "weekDay": "SUN",
- "hour": 23,
- "minute": 59
}
}
]
}
]
}Configures the Forklift QueueManagement reporting configuration, for supported values refer to forkliftqueuemanagement/report/options response.
| channel required | integer <int32> | ||||||||||||||||||||
Array of objects (RuleReportingConfiguration) | |||||||||||||||||||||
Array
| |||||||||||||||||||||
{- "channel": 0,
- "reportingRules": [
- {
- "index": 1,
- "reportEnable": true,
- "reportFileName": "string",
- "reportFileType": "string",
- "reportingSchedule": {
- "scheduleType": "string",
- "weekDay": "SUN",
- "hour": 23,
- "minute": 59
}
}
]
}{- "response": "Success"
}Provides the supported values and ranges for the Forklift QueueManagement reporting configuration.
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "reportingConfigurationOptions": [
- {
- "channel": 0,
- "ruleReportingOptions": {
- "index": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "reportFileTypes": [
- "string"
], - "reportingScheduleOptions": {
- "scheduleTypes": [
- "string"
], - "weekDays": [
- "string"
], - "hour": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "minute": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}
}
}
}
]
}Clears the Forklift QueueManagement that is stored.
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "response": "Success"
}Initiate the forklift queuemanagement search based on search time duration and returns a search token
| channel required | integer <int32> Required channel parameter, operation is applicable only for the specified channel. |
| fromDate required | string <date-time> To filter results after the specified date time, example format 2021-07-28T04:40:16Z, if suffix Z not specified will be considered as local time. |
| toDate required | string <date-time> To filter results till the specified date time, example format 2021-07-28T04:40:16Z, if suffix Z not specified will be considered as local time. |
object (QueueSearchQueryObject) Advanced result filtering based on queue name |
{- "searchToken": "SearchToken-122212"
}Search token can be used to check if the search status is complete.
| searchToken required | string search token received after initiating search |
{- "status": "Completed"
}Client can cancel an intiated search session using this method. Should pass a valid search token to cancel.
| searchToken required | string search token received after initiating search |
{- "response": "Success"
}Once the search is complete, using the search token forklift queuemanagement results can be retreived.
| searchToken required | string search token received after initiating search |
{- "resultInterval": "Hourly",
- "queues": [
- {
- "index": 0,
- "averagePeopleResult": [
- 0
], - "queueLevelHigh": {
- "cumulativeTimeResult": [
- 0
]
}, - "queueLevelMedium": {
- "cumulativeTimeResult": [
- 0
]
}
}
]
}Getting the live queue count
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
| index | Array of integers <int32> non-empty [ items <int32 > >= 1 ] Examples:
Optional parameter, used to set a specific index. |
{- "queueCount": [
- {
- "channel": 0,
- "queues": [
- {
- "index": 0,
- "count": 0
}
]
}
]
}Get the Forklift configuration, supported only if forkliftheatmap capability is set to true.
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "heatmapConfigurations": [
- {
- "channel": 0,
- "enable": true,
- "backgroundColorMode": "string",
- "enableManualReferenceMode": true,
- "autoReference": 0,
- "manualReference": 0,
- "excludeAreas": [
- {
- "index": 1,
- "name": "string",
- "areaCoordinates": [
- {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}
]
}
]
}
]
}Configures the Forklift heatmap settings. For the supported values refer to forkliftheatmap/options response.
| channel required | integer <int32> | ||||||||||||
| enable | boolean | ||||||||||||
| backgroundColorMode | string | ||||||||||||
| enableManualReferenceMode | boolean | ||||||||||||
| manualReference | integer <int32> | ||||||||||||
Array of objects (ExcludeAreaElement) | |||||||||||||
Array
| |||||||||||||
{- "channel": 0,
- "enable": true,
- "backgroundColorMode": "string",
- "enableManualReferenceMode": true,
- "manualReference": 0,
- "excludeAreas": [
- {
- "index": 1,
- "name": "string",
- "areaCoordinates": [
- {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}
]
}
]
}{- "response": "Success"
}Provides the supported values and ranges for the Forklift heatmap configuration.
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "heatmapConfigurationOptions": [
- {
- "channel": 0,
- "backgroundColorModes": [
- "string"
], - "manualReference": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "excludeAreaOptions": {
- "index": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "areaCoordinates": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}
}
}
]
}Delete the excludearea based on the requested exclude area index.
| channel required | integer <int32> Required channel parameter, operation is applicable only for the specified channel. |
| index required | Array of integers <int32> non-empty [ items <int32 > >= 1 ] Examples:
Required parameter, used to set a specific index. |
{- "response": "Success"
}Provides the reporting configuration of Forklift heatmap
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "reportingConfigurations": [
- {
- "channel": 0,
- "reportingRules": [
- {
- "index": 1,
- "reportEnable": true,
- "reportFileName": "string",
- "reportFileType": "string",
- "reportingSchedule": {
- "scheduleType": "string",
- "weekDay": "SUN",
- "hour": 23,
- "minute": 59
}
}
]
}
]
}Configures the Forklift heatmap reporting configuration, for supported values refer to forkliftheatmap/report/options response.
| channel required | integer <int32> | ||||||||||||||||||||
Array of objects (RuleReportingConfiguration) | |||||||||||||||||||||
Array
| |||||||||||||||||||||
{- "channel": 0,
- "reportingRules": [
- {
- "index": 1,
- "reportEnable": true,
- "reportFileName": "string",
- "reportFileType": "string",
- "reportingSchedule": {
- "scheduleType": "string",
- "weekDay": "SUN",
- "hour": 23,
- "minute": 59
}
}
]
}{- "response": "Success"
}Provides the supported values and ranges for the Forklift heatmap reporting configuration.
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "reportingConfigurationOptions": [
- {
- "channel": 0,
- "ruleReportingOptions": {
- "index": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "reportFileTypes": [
- "string"
], - "reportingScheduleOptions": {
- "scheduleTypes": [
- "string"
], - "weekDays": [
- "string"
], - "hour": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "minute": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}
}
}
}
]
}Clears the Forklift heatmap that is stored.
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "response": "Success"
}Initiate the forklift heatmap search based on search time duration and returns a search token
| channel required | integer <int32> Required channel parameter, operation is applicable only for the specified channel. |
| fromDate required | string <date-time> To filter results after the specified date time, example format 2021-07-28T04:40:16Z, if suffix Z not specified will be considered as local time. |
| toDate required | string <date-time> To filter results till the specified date time, example format 2021-07-28T04:40:16Z, if suffix Z not specified will be considered as local time. |
| resultFormat | string Enum: "Image" "Json" Optional format parameter to get the search result in requested format. Default format is image. |
| resultImageType | string Enum: "WithBackground" "WithoutBackground" Example: resultImageType=WithBackground Optional result Image type selection, if not passed WithBackground will be selected. It's used when the resultFormat paramter is image |
{- "searchToken": "SearchToken-122212"
}Client can cancel an intiated search session using this method. Should pass a valid search token to cancel.
| searchToken required | string search token received after initiating search |
{- "response": "Success"
}Once the search is complete, using the search token forklift heatmap image can be downloaded.
| searchToken required | string search token received after initiating search |
{- "response": "Fail",
- "error": {
- "code": 607,
- "details": "Unknown Error"
}
}Getting the live forklift heatmap levels
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "heatmap": [
- {
- "channel": 0,
- "level": [
- 0
], - "resolution": {
- "width": 0,
- "height": 0
}, - "descriptor": 0
}
]
}Gets the forklift speed detection settings, suppport only if forkliftspeeddetection capability is set to true.
tns1:OpenApp/WiseAI/ForkliftSpeedDetection
<?xml version="1.0" encoding="UTF-8"?>
<ForkliftSpeedDetection wstop:topic="true">
<tt:MessageDescription>
<tt:Source>
<tt:SimpleItemDescription Name="VideoSourceToken" Type="tt:ReferenceToken"/>
<tt:SimpleItemDescription Name="RuleName" Type="xsd:string"/>
</tt:Source>
<tt:Data>
<tt:SimpleItemDescription Name="Speed" Type="xsd:float"/>
<tt:SimpleItemDescription Name="ObjectId" Type="xsd:integer"/>
<tt:SimpleItemDescription Name="State" Type="xsd:boolean"/>
</tt:Data>
</tt:MessageDescription>
</ForkliftSpeedDetection>
Channel.0.OpenSDK.WiseAI.ForkliftSpeedDetection=True
Channel.0.OpenSDK.WiseAI.ForkliftSpeedDetection.1=True
Channel.0.OpenSDK.WiseAI.ForkliftSpeedDetection=True
Channel.0.OpenSDK.WiseAI.ForkliftSpeedDetection.1.VideoSourceToken=VideoSourceToken-0
Channel.0.OpenSDK.WiseAI.ForkliftSpeedDetection.1.RuleName=RuleName1
Channel.0.OpenSDK.WiseAI.ForkliftSpeedDetection.1.Speed=3.5
Channel.0.OpenSDK.WiseAI.ForkliftSpeedDetection.1.ObjectId=1234
Channel.0.OpenSDK.WiseAI.ForkliftSpeedDetection.1.State=True
{
"EventName": "OpenSDK.WiseAI.ForkliftSpeedDetection",
"Time": "2022-03-15T02:58:52.820+00:00",
"Source": {
"Channel": 0,
"AppName": "WiseAI",
"AppID": "WiseAI",
"AppEvent": "ForkliftSpeedDetection",
"Type": "Event",
"RuleIndex": 1,
"VideoSourceToken": "VideoSourceToken-0",
"RuleName": "rulename"
},
"Data": {
"Speed": 3.5,
"ObjectId": 1234,
"State": true
}
}
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "forkliftSpeedDetection": [
- {
- "channel": 0,
- "enable": true,
- "distanceSpeedUnit": "string",
- "cameraHeight": 0.1,
- "tilt": 0.1,
- "roll": 0.1,
- "focalLength": 0.1,
- "speed": 0.1,
- "duration": 0
}
]
}Configures the forklift speed detection settings, for supported values and ranges refer to forkliftspeeddetection/options response.
| channel | integer <int32> |
| enable | boolean |
| distanceSpeedUnit | string |
| cameraHeight | number <double> Camera height from floor (unit depends on distanceSpeedUnit setting) |
| tilt | number <double> |
| roll | number <double> |
| focalLength | number <double> |
| speed | number <double> Speed of vehicle, if vehicles are moving above this speed event would be generated. Unit depends on distanceSpeedUnit parameter. |
| duration | integer <int32> If vehicles are moving at configured speed for this duration, event is generated. Time is configured in seconds |
{- "channel": 0,
- "enable": true,
- "distanceSpeedUnit": "string",
- "cameraHeight": 0.1,
- "tilt": 0.1,
- "roll": 0.1,
- "focalLength": 0.1,
- "speed": 0.1,
- "duration": 0
}{- "response": "Success"
}Supported values and ranges reguired for configuring forklift speed detection is provided in response.
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "detectionOptions": [
- {
- "channel": 0,
- "distanceSpeedUnit": [
- "string"
], - "tilt": {
- "min": 0.1,
- "max": 0.1,
- "step": 0.1,
- "default": 0.1
}, - "roll": {
- "min": 0.1,
- "max": 0.1,
- "step": 0.1,
- "default": 0.1
}, - "focalLength": {
- "min": 0.1,
- "max": 0.1,
- "step": 0.1,
- "default": 0.1
}, - "duration": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "kph": {
- "cameraHeight": {
- "min": 0.1,
- "max": 0.1,
- "step": 0.1,
- "default": 0.1
}, - "speed": {
- "min": 0.1,
- "max": 0.1,
- "step": 0.1,
- "default": 0.1
}
}, - "mph": {
- "cameraHeight": {
- "min": 0.1,
- "max": 0.1,
- "step": 0.1,
- "default": 0.1
}, - "speed": {
- "min": 0.1,
- "max": 0.1,
- "step": 0.1,
- "default": 0.1
}
}
}
]
}Get the sound classification event configurations, a device that indicates capability of soundclassification in getcapability command shall support this command. When this soundclassification feature is enabled event will be delivered in following formats.
tns1:OpenApp/WiseAI/SoundClassification
<?xml version="1.0" encoding="UTF-8"?>
<SoundClassification wstop:topic="true" xmlns:tt="http://www.onvif.org/ver10/schema">
<tt:MessageDescription>
<tt:Source>
<tt:SimpleItemDescription Name="AudioSource" Type="tt:ReferenceToken"/>
<tt:SimpleItemDescription Name="RuleName" Type="xsd:string"/>
</tt:Source>
<tt:Data>
<tt:SimpleItemDescription Name="ClassTypes" Type="tt:StringList"/>
<tt:SimpleItemDescription Name="State" Type="xsd:boolean"/>
<tt:SimpleItemDescription Name="AudioURI" Type="xsd:anyUri"/>
<tt:SimpleItemDescription Name="Score" Type="tt:FloatList"/> // scores of detected sound classifications (normalized 0 ~ 1 as float)
<tt:SimpleItemDescription Name="Loudness" Type="xsd:float"/> // in dB
<tt:SimpleItemDescription Name="DirectionAsRPY" Type="tt:FloatList"/>
</tt:Data>
</tt:MessageDescription>
</SoundClassification>
Channel.0.OpenSDK.WiseAI.SoundClassification=True
Channel.0.OpenSDK.WiseAI.SoundClassification.1=True
Channel.0.OpenSDK.WiseAI.SoundClassification=True
Channel.0.OpenSDK.WiseAI.SoundClassification.1.AudioSource=AudioSourceToken-0
Channel.0.OpenSDK.WiseAI.SoundClassification.1.RuleName=RuleName1
Channel.0.OpenSDK.WiseAI.SoundClassification.1.ClassTypes=Scream GunShot GlassBreaking
Channel.0.OpenSDK.WiseAI.SoundClassification.1.State=True
Channel.0.OpenSDK.WiseAI.SoundClassification.1.AudioURI=/download/audio.wav
Channel.0.OpenSDK.WiseAI.SoundClassification.1.Score=0.5 0.2 0.3
Channel.0.OpenSDK.WiseAI.SoundClassification.1.Loudness=10
Channel.0.OpenSDK.WiseAI.SoundClassification.1.DirectionAsRPY=0.0 0.0 0.0
{
"EventName": "OpenSDK.WiseAI.SoundClassification",
"Time": "2021-10-27T07:36:14.509+00:00",
"Source": {
"Channel": 0,
"AppName": "WiseAI",
"AppEvent": "SoundClassification",
"AppID": "WiseAI",
"Type": "Event",
"RuleIndex": 1,
"AudioSource": "AudioSourceToken-0,
"RuleName": "Rule1",
},
"Data": {
"ClassTypes": "Scream GunShot GlassBreaking",
"State": true,
"AudioURI": "/download/audio.wav",
"Score": "0.5 0.2 0.3",
"Loudness": 10,
"DirectionAsRPY": "0.0 0.0 0.0"
}
}
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "configurations": [
- {
- "channel": 0,
- "enable": true,
- "noiseReduction": true,
- "detectSoundDirection": true,
- "thresholdLevel": 1,
- "classTypes": [
- "string"
], - "audioClipEnable": true,
- "audioClipPreDuration": 0,
- "audioClipFileType": "string"
}
]
}object detecion setting, a device that indicates capability of soundclassification in getcapability command shall support this command.
| channel required | integer <int32> |
| enable | boolean |
| noiseReduction | boolean Whether to enable noise reduction |
| detectSoundDirection | boolean Whether to detect sound direction. For support of this setting, refer to detectSoundDirectionSupport in options |
| thresholdLevel | integer <int32> [ 1 .. 100 ] |
| classTypes | Array of strings List of classTypes to be detected, supported list is provided in options. Eg, Scream, Gunshot, GlassBreak etc., |
| audioClipEnable | boolean Whether to create an audio clip when an event occurs and serve it as an event |
| audioClipPreDuration | integer <int32> Pre-duration (in seconds) of the audio clip generated when the event occurs |
| audioClipFileType | string |
{- "channel": 0,
- "enable": true,
- "noiseReduction": true,
- "detectSoundDirection": true,
- "thresholdLevel": 1,
- "classTypes": [
- "string"
], - "audioClipEnable": true,
- "audioClipPreDuration": 0,
- "audioClipFileType": "string"
}{- "response": "Success"
}Get the sound classification event configurations options, a device that indicates capability of soundclassification in getcapability command shall support this command.
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "configurationOptions": [
- {
- "channel": 0,
- "classTypes": [
- "string"
], - "audioClipPreDuration": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "audioClipFileType": [
- "string"
], - "detectSoundDirectionSupport": true,
- "detectLoudnessSupport": true
}
]
}Getting the sound classification levels
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
| maxSamples | integer <int32> [ 1 .. 10 ] Optional maximum samples |
{- "soundClassificationLevel": [
- {
- "channel": 0,
- "samples": [
- {
- "sequenceId": 0,
- "level": 0
}
]
}
]
}Get the roi information based motion detection configurations. Area based motion detection configurations, a device that indicates capability of motiondetectionarea in getcapability command shall support this command. When this motiondetectionarea feature is enabled event will be delivered following below schema format.
tns1:OpenApp/WiseAI/MotionDetectionArea
<?xml version="1.0" encoding="UTF-8"?>
<MotionDetectionArea wstop:topic="true">
<tt:MessageDescription>
<tt:Source>
<tt:SimpleItemDescription Name="VideoSourceToken" Type="tt:ReferenceToken"/>
<tt:SimpleItemDescription Name="RuleName" Type="xsd:string"/>
</tt:Source>
<tt:Data>
<tt:SimpleItemDescription Name="State" Type="xsd:boolean"/>
<tt:SimpleItemDescription Name="Level" Type="xsd:integer"/>
</tt:Data>
</tt:MessageDescription>
</MotionDetectionArea>
Channel.0.OpenSDK.WiseAI.MotionDetectionArea=True
Channel.0.OpenSDK.WiseAI.MotionDetectionArea=True
Channel.0.OpenSDK.WiseAI.MotionDetectionArea.1.VideoSourceToken=vs-0
Channel.0.OpenSDK.WiseAI.MotionDetectionArea.1.RuleName=Rule1
Channel.0.OpenSDK.WiseAI.MotionDetectionArea.1.State=True
Channel.0.OpenSDK.WiseAI.MotionDetectionArea.1.Level=15
{
"EventName": "OpenSDK.WiseAI.MotionDetectionArea",
"Time": "2021-10-27T07:36:14.509+00:00",
"Source": {
"Channel": 0,
"AppName": "WiseAI",
"AppID": "WiseAI",
"AppEvent": "MotionDetectionArea",
"Type": "Event",
"RuleIndex": 1,
"VideoSourceToken": "vs-0",
"RuleName": "Rule1",
},
"Data": {
"State": true
"Level": 15
}
}
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "motionDetectionArea": [
- {
- "channel": 0,
- "enable": true,
- "mdArea": [
- {
- "index": 1,
- "name": "string",
- "areaCoordinates": [
- {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}
], - "sensitivity": 1,
- "thresholdLevel": 1,
- "duration": 0,
- "objectTypeFilter": [
- "string"
]
}
]
}
]
}Update or enable area based motion detection configuration. Area based configurations, a device that indicates capability of wisemdarea in getcapability command shall support this command.
| channel required | integer <int32> | ||||||||||||||||||||
| enable | boolean | ||||||||||||||||||||
Array of objects (WiseMDAreaElement) | |||||||||||||||||||||
Array
| |||||||||||||||||||||
{- "channel": 0,
- "enable": true,
- "mdArea": [
- {
- "index": 1,
- "name": "string",
- "areaCoordinates": [
- {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}, - {
- "x": 0,
- "y": 0
}
], - "sensitivity": 1,
- "thresholdLevel": 1,
- "duration": 0,
- "objectTypeFilter": [
- "string"
]
}
]
}{- "response": "Success"
}Provide allowed values of each parameters in area based analytics configuration. Ranges of parameters in area based analytcis configuration, a device that indicates capability of ivaarea in getcapability command shall support this command.
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
{- "mdAreaOptions": [
- {
- "channel": 0,
- "mdAreaOptions": {
- "index": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "areaCoordinates": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "sensitivity": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "thresholdLevel": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "duration": {
- "min": 0,
- "max": 0,
- "step": 0,
- "default": 0
}, - "objectTypeFilter": [
- "string"
]
}
}
]
}Delete the area for the requested index.
| channel required | integer <int32> Required channel parameter, operation is applicable only for the specified channel. |
| index required | Array of integers <int32> non-empty [ items <int32 > >= 1 ] Examples:
Required parameter, used to set a specific index. |
{- "response": "Success"
}Provide a set of current levels of motion detection. Users can request numbers of levels to be recevied.
| channel | Array of integers <int32> non-empty [ items <int32 > ] Examples:
Optional channel parameter if passed, operation is applicable only for the specified channels. |
| mdAreaIndex | integer Required rule index parameter, unique indentifier of the rule |
| numberOfSample required | integer Required number of sample parameter to be received. |
{- "motionDetectionAreaLive": [
- {
- "channel": 0,
- "mdArea": [
- {
- "index": 0,
- "sequenceId": 0,
- "level": 100
}
]
}
]
}